Conditional приложение

Описание

Как часто бывает в промышленной разработке, мы хотим в локальном или dev окружении использовать несколько упрощенные варианты наших сервисов. Поэтому сегодня мы напишем приложение на Spring boot, в котором в зависимости от параметров, будут вызываться разные сервисы.

Для работы необходимо подготовить несколько классов:

• Создайте spring boot приложение, как было сделано на лекции

• Нам нужен интерфейс, реализации которого мы будем вызывать в зависимости от параметров нашего приложения:

public interface SystemProfile {
     String getProfile();
}

И две реализации:

public class DevProfile implements SystemProfile {
     @Override
     public String getProfile() {
         return "Current profile is dev";
     }
}

и

public class ProductionProfile implements SystemProfile {
     @Override
     public String getProfile() {
         return "Current profile is production";
     }
}

Вам необходимо написать JavaConfig, в котором вы объявите бины классов DevProfile и ProductionProfile примерно так:

    @Bean
    public SystemProfile devProfile() {
        return new DevProfile();
    }

    @Bean
    public SystemProfile prodProfile() {
        return new ProductionProfile();
    }

• Дальше вам нужно создать application.properties в папке resources, если его нет, и добавить туда свой пользовательский параметр netology.profile.dev = true. Обратите внимание, что сейчас наш параметр имеет значение true. Как раз таки в зависимости от значения параметра, мы и будем использовать ту или иную реализацию интерфейса SystemProfile.

• Теперь, вам нужно использовать одну из аннотаций @Conditional и поместить ее на бины в вашем JavaConfig. Советую использовать @ConditionalOnProperty, и в зависимости от значения netology.profile.dev будет создаваться бин интерфейса SystemProfile той или иной реализации.

Чтобы проверить работоспособность нашей логики, создадим контроллер, который будет нам возвращать значения из нашего сервиса SystemProfile:

@RestController
@RequestMapping("/")
public class ProfileController {
    private SystemProfile profile;

    public ProfileController(SystemProfile profile) {
        this.profile = profile;
    }

    @GetMapping("profile")
    public String getProfile() {
        return profile.getProfile();
    }
}

Задача Интеграционное тестирование

Теперь, когда мы умеем создавать образы и знаем, что можно их тестировать из Java кода, можно протестировать приложение https://github.com/AnnaGubkina/Conditional.

Описание

1. Первым делом нам надо собрать jar архивы с нашими spring boot приложениями. Для этого в терминале в корне нашего проект выполните команду:

Для gradle: ./gradlew clean build (если пишет Permission denied тогда сначала выполните chmod +x ./gradlew)

Для maven: ./mvnw clean package (если пишет Permission denied тогда сначала выполните chmod +x ./mvnw)

2. Теперь мы соберем два образа для разных окружений - dev и prod. Для этого:

• для первого установите порт server.port=8080 и профиль в dev с помощью параметра netology.profile.dev=true в application.properties и соберите приложение:

Для gradle :

./gradlew clean build (если пишет Permission denied тогда сначала выполните chmod +x ./gradlew)

Для maven:

./mvnw clean package (если пишет Permission denied тогда сначала выполните chmod +x ./mvnw)

3. добавьте Dockerfile в корень проекта:

FROM openjdk:8-jdk-alpine
EXPOSE 8080
ADD build/libs/<название вашего архива>.jar myapp.jar
ENTRYPOINT ["java","-jar","/myapp.jar"]

Если вы собирали с помощью maven, тогда jar будет лежать в папке target, а если gradle - в build/libs, и, соответственно, в ADD надо прописывать путь изходя из того, какой сборщик вы использовали.

4. теперь соберите образ выполнив в корне проекта в терминале команду docker build -t devapp . Так мы соберем наше приложение в образ с названием devapp.
5. И теперь нам надо собрать второй образ из этого же приложения, но с другими параметрами:

• установите порт server.port=8081 и профиль в prod с помощью параметра netology.profile.dev=false в application.properties и соберите приложение как в предыдущем пунтке.
• измените в Dockerfile параметр EXPOSE с 8080 на 8081.
• соберите образ выполнив в корне проекта в терминале команду docker build -t prodapp . . Так мы соберем наше приложение в образ с названием prodapp.

6. Напишем наш интеграционный тест: добавьте в зависимость проекта для gradle - testImplementation 'org.testcontainers:junit-jupiter:1.15.1'

для maven -

<dependency>
    <groupId>org.testcontainers</groupId>
    <artifactId>junit-jupiter</artifactId>
    <version>1.15.1</version>
    <scope>test</scope>
</dependency>

7. напишите тестовый класс в директории src/test:

@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
class DemoApplicationTests {
    @Autowired
    TestRestTemplate restTemplate;

    @BeforeAll
    public static void setUp() {
     
    }

    @Test
    void contextLoads() {
        ResponseEntity<String> forEntity = restTemplate.getForEntity("http://localhost:" + myapp.getMappedPort(8080), String.class);
        System.out.println(forEntity.getBody());
    }

}

• здесь вам надо создать два своих GenericContainer в полях класса - каждый под свой образ, который мы создали ранее.

• в методе setUp() стартуйте контейнеры своих образов.

• напишите два юнит теста для проверки корректности того, что вернет вам ваше приложение. Для этого используйте объект класса TestRestTemplate, который представлен в примере. С помощью него сделайте запрос.

• Для того, чтобы понять на каком порту запущен ваш контейнер, воспользуйтесь методом getMappedPort, как на примере из лекции. И для проверки корректности ответа проверьте с помощью метода assertEquals.