Feature Toggle Testing With Spring Boot
This repository is to demonstrate feature toggle functional testing (developer's integration testing) with Spring Boot. Spring boot and dependency injection is used in this repository, still the code can be ported to projects using no frameworks or other frameworks.
Github Actions Build status
Required Softwares, Tools and Version
- Java JDK Version: 11
- Apache Maven Version: 3.6.3
- Gradle Version: 7.1
- Chrome (Windows & Mac OS) Browser / Chromium (Linux OS) Browser: 91
- chromedriver: 91 chromedriver installation steps
- Git Client: Any latest version
- Integrated Development Environment: Any version of IntelliJ Idea or Eclipse
Approach to feature toggle integration test
Please refer to my blog post about feature toggle and importance of integration testing
Feature Toggle Integration Testing with Spring Boot
Sample integration tests
src/test/java/com/harishkannarao/demo/feature_toggle/test/integration/HomePageIntegrationTest.java tests the behaviour of a web page with feature toggle enabled and disabled.
src/test/java/com/harishkannarao/demo/feature_toggle/test/integration/ProductsApiIntegrationTest.java tests the behaviour of an api with feature toggle enabled and disabled.
Running the build
Note: For gradle users on Windows, please use gradlew.bat instead of ./gradlew in the following commands
For Maven users
mvn clean install
For Gradle users
./gradlew clean build
Running the application using build tool
For Maven users
With feature toggled off (default behaviour)
mvn spring-boot:run
With feature toggled on
mvn spring-boot:run -Dspring-boot.run.jvmArguments="-Dapplication-config.display-hidden-products=true"
With integration test configuration
mvn test-compile exec:java@run-local -Dapplication-config.display-hidden-products=true
For Gradle users
With feature toggled off (default behaviour)
./gradlew bootRun
With feature toggled on
./gradlew bootRun -Dapplication-config.display-hidden-products=true
With integration test configuration
./gradlew runLocal -Dapplication-config.display-hidden-products=true
Application url
http://localhost:8080
Run the sample application using java
Generate the jar file and start the application
For Maven users
mvn clean install -DskipTests=true
With feature toggled off (default behaviour)
java -jar target/feature-toggle-testing-with-spring-boot-1.0-SNAPSHOT-exec.jar
With feature toggled on
java -Dapplication-config.display-hidden-products=true -jar target/feature-toggle-testing-with-spring-boot-1.0-SNAPSHOT-exec.jar
For Gradle users
./gradlew clean assemble
With feature toggled off (default behaviour)
java -jar build/libs/feature-toggle-testing-with-spring-boot-1.0-SNAPSHOT-exec.jar
With feature toggled on
java -Dapplication-config.display-hidden-products=true -jar build/libs/feature-toggle-testing-with-spring-boot-1.0-SNAPSHOT-exec.jar
Application url
http://localhost:8080
Feature toggling in production
Most of cloud providers like heroku or cloud foundry provide mechanism to set environment variables on application scope through configuration file. This will be a convenient way to toggle features using environment variable and restart the application with zero downtime and without the need to redeploy the application.
With spring boot application-config.display-hidden-products property is represented by APPLICATION_CONFIG_DISPLAY_HIDDEN_PRODUCTS environment variable (i.e replace all '-' and '.' with '_')
Set the environment variable
export APPLICATION_CONFIG_DISPLAY_HIDDEN_PRODUCTS=true
Start the application using java
java -jar target/feature-toggle-testing-with-spring-boot-1.0-SNAPSHOT-exec.jar
or
java -jar build/libs/feature-toggle-testing-with-spring-boot-1.0-SNAPSHOT-exec.jar