Set preset in Spring Config

[pascalgrimaud]

• fix preset.json in spring config  #10553

[renanfranca]

@pascalgrimaud : A error was detected with custom-jhlite module, what do you think about this fix?
#10609 (comment)

This must be done in this same PR.

[pascalgrimaud]

@renanfranca : I tested locally jhlite custom with the following code here and it works, as I used default override mechanism by Spring, so the property will be set with the default value preset.json

[renanfranca]

@renanfranca : I tested locally jhlite custom with the following code here and it works, as I used default override mechanism by Spring, so the property will be set with the default value preset.json

Nice! Thanks!

@pascalgrimaud : If you change the property at application.yml the cucumber test will fail. To avoid that the class FakedFileSystemProjectFilesConfiguration.java should be change:

the line to change:

from:
Mockito.doReturn(presetJsonContent.getBytes(StandardCharsets.UTF_8)).when(fileSystemProjectFiles).readBytes("/preset.json");

to:
Mockito.doReturn(presetJsonContent.getBytes(StandardCharsets.UTF_8)).when(fileSystemProjectFiles).readBytes(anyString());

The class without and with the change:

from:

ackage tech.jhipster.lite.project.infrastructure.secondary;

import java.nio.charset.StandardCharsets;
import org.mockito.Mockito;
import org.springframework.boot.test.context.TestConfiguration;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Primary;
import tech.jhipster.lite.module.infrastructure.secondary.FileSystemProjectFiles;

@TestConfiguration
public class FakedFileSystemProjectFilesConfiguration {

  @Bean
  @Primary
  FileSystemProjectFiles fileSystemProjectFiles() {
    FileSystemProjectFiles fileSystemProjectFiles = Mockito.spy(new FileSystemProjectFiles());

    mockPresetJson(fileSystemProjectFiles);

    return fileSystemProjectFiles;
  }

  private static void mockPresetJson(FileSystemProjectFiles fileSystemProjectFiles) {
    String presetJsonContent =
      """
      {
        "presets": [
          {
            "name": "test preset one",
            "modules": ["test-module-one", "test-module-two"]
          },
          {
            "name": "test preset two",
            "modules": ["test-module-three", "test-module-four"]
          }
        ]
      }
      """;

    Mockito.doReturn(presetJsonContent.getBytes(StandardCharsets.UTF_8)).when(fileSystemProjectFiles).readBytes("/preset.json");
  }
}

to:

package tech.jhipster.lite.project.infrastructure.secondary;

import static org.mockito.ArgumentMatchers.*;

import java.nio.charset.StandardCharsets;
import org.mockito.Mockito;
import org.springframework.boot.test.context.TestConfiguration;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Primary;
import tech.jhipster.lite.module.infrastructure.secondary.FileSystemProjectFiles;

@TestConfiguration
public class FakedFileSystemProjectFilesConfiguration {

  @Bean
  @Primary
  FileSystemProjectFiles fileSystemProjectFiles() {
    FileSystemProjectFiles fileSystemProjectFiles = Mockito.spy(new FileSystemProjectFiles());

    mockPresetJson(fileSystemProjectFiles);

    return fileSystemProjectFiles;
  }

  private static void mockPresetJson(FileSystemProjectFiles fileSystemProjectFiles) {
    String presetJsonContent =
      """
      {
        "presets": [
          {
            "name": "test preset one",
            "modules": ["test-module-one", "test-module-two"]
          },
          {
            "name": "test preset two",
            "modules": ["test-module-three", "test-module-four"]
          }
        ]
      }
      """;

    Mockito.doReturn(presetJsonContent.getBytes(StandardCharsets.UTF_8)).when(fileSystemProjectFiles).readBytes(anyString());
  }
}

[pascalgrimaud]

@renanfranca : nice catch and thanks. See my last commit, we should not need to apply this additional code about Cucumber

[renanfranca]

@renanfranca : I tested locally jhlite custom with the following code here and it works, as I used default override mechanism by Spring, so the property will be set with the default value preset.json

Nice! Thanks!

@pascalgrimaud : If you change the property at application.yml the cucumber test will fail. To avoid that the class FakedFileSystemProjectFilesConfiguration.java should be change:

the line to change:

from: Mockito.doReturn(presetJsonContent.getBytes(StandardCharsets.UTF_8)).when(fileSystemProjectFiles).readBytes("/preset.json");

to: Mockito.doReturn(presetJsonContent.getBytes(StandardCharsets.UTF_8)).when(fileSystemProjectFiles).readBytes(anyString());

The class without and with the change:

from:

ackage tech.jhipster.lite.project.infrastructure.secondary;

import java.nio.charset.StandardCharsets;
import org.mockito.Mockito;
import org.springframework.boot.test.context.TestConfiguration;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Primary;
import tech.jhipster.lite.module.infrastructure.secondary.FileSystemProjectFiles;

@TestConfiguration
public class FakedFileSystemProjectFilesConfiguration {

  @Bean
  @Primary
  FileSystemProjectFiles fileSystemProjectFiles() {
    FileSystemProjectFiles fileSystemProjectFiles = Mockito.spy(new FileSystemProjectFiles());

    mockPresetJson(fileSystemProjectFiles);

    return fileSystemProjectFiles;
  }

  private static void mockPresetJson(FileSystemProjectFiles fileSystemProjectFiles) {
    String presetJsonContent =
      """
      {
        "presets": [
          {
            "name": "test preset one",
            "modules": ["test-module-one", "test-module-two"]
          },
          {
            "name": "test preset two",
            "modules": ["test-module-three", "test-module-four"]
          }
        ]
      }
      """;

    Mockito.doReturn(presetJsonContent.getBytes(StandardCharsets.UTF_8)).when(fileSystemProjectFiles).readBytes("/preset.json");
  }
}

to:

package tech.jhipster.lite.project.infrastructure.secondary;

import static org.mockito.ArgumentMatchers.*;

import java.nio.charset.StandardCharsets;
import org.mockito.Mockito;
import org.springframework.boot.test.context.TestConfiguration;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Primary;
import tech.jhipster.lite.module.infrastructure.secondary.FileSystemProjectFiles;

@TestConfiguration
public class FakedFileSystemProjectFilesConfiguration {

  @Bean
  @Primary
  FileSystemProjectFiles fileSystemProjectFiles() {
    FileSystemProjectFiles fileSystemProjectFiles = Mockito.spy(new FileSystemProjectFiles());

    mockPresetJson(fileSystemProjectFiles);

    return fileSystemProjectFiles;
  }

  private static void mockPresetJson(FileSystemProjectFiles fileSystemProjectFiles) {
    String presetJsonContent =
      """
      {
        "presets": [
          {
            "name": "test preset one",
            "modules": ["test-module-one", "test-module-two"]
          },
          {
            "name": "test preset two",
            "modules": ["test-module-three", "test-module-four"]
          }
        ]
      }
      """;

    Mockito.doReturn(presetJsonContent.getBytes(StandardCharsets.UTF_8)).when(fileSystemProjectFiles).readBytes(anyString());
  }
}

@pascalgrimaud

If you change the property at application.yml the cucumber test will fail. To avoid that the class FakedFileSystemProjectFilesConfiguration.java should be change:

the line to change:

from: Mockito.doReturn(presetJsonContent.getBytes(StandardCharsets.UTF_8)).when(fileSystemProjectFiles).readBytes("/preset.json");

to: Mockito.doReturn(presetJsonContent.getBytes(StandardCharsets.UTF_8)).when(fileSystemProjectFiles).readBytes(anyString());

@pascalgrimaud : please, hold on. Don't implement that change, it will break a lot of other tests and won't fix the problem when the preset-filename.name is changed!

I don't have a solution right now from the top of my head.

[renanfranca]

@renanfranca : nice catch and thanks. See my last commit, we should not need to apply this additional code about Cucumber

@pascalgrimaud : Greate! Thanks for the solution, I didn't see that option implement the code in my head 😅

[renanfranca]

Thanks @pascalgrimaud for your work! 😃