Testcontainers:Kubernetesオペレーターをテストする最も簡単な方法

git clone https://github.com/testcontainers-community/testcontainers-kubernetes-operator-demo

%test.quarkus.kubernetes-client.devservices.enabled=false

<dependency>
     <groupId>org.testcontainers</groupId>
     <artifactId>junit-jupiter</artifactId>
     <version>${testcontainers.version}</version>
     <scope>test</scope>
</dependency>
<dependency>
     <groupId>org.testcontainers</groupId>
     <artifactId>k3s</artifactId>
     <version>${testcontainers.version}</version>
     <scope>test</scope>
</dependency>

package com.systemcraftsman.kubegame.test;
import io.quarkus.test.common.QuarkusTestResourceLifecycleManager;
import org.testcontainers.k3s.K3sContainer;
import org.testcontainers.utility.DockerImageName;
import java.util.Collections;
import java.util.Map;
public class K3sResource implements QuarkusTestResourceLifecycleManager {
   //Initializes the K3sContainer instance.
   //It uses the Docker image "rancher/k3s:v1.24.12-k3s1"
   static K3sContainer k3sContainer = new K3sContainer(DockerImageName.parse("rancher/k3s:v1.24.12-k3s1"));
   //Start method is one of the methods in the interface QuarkusTestResourceLifecycleManager
   //This method runs when a test lifecycle is started
   //In this case, it is used for starting the container and setting the kubeConfigYaml value into a property.
   @Override
   public Map<String, String> start() {
       k3sContainer.start();
       return Collections.singletonMap("kubeConfigYaml", k3sContainer.getKubeConfigYaml());
   }
   //Stop method is one of the methods in the interface QuarkusTestResourceLifecycleManager
   //This method runs when a test lifecycle is stopped
   //In this case, it is used for stopping the container
   @Override
   public void stop() {
       k3sContainer.stop();
   }
}

K3sContainer
@QuarkusTestResource(K3sResource.class)
...code omitted...
public class OperatorFunctionalTest {
  ...
  ...
}

package com.systemcraftsman.kubegame.test;
import io.fabric8.kubernetes.client.Config;
import io.quarkus.arc.Priority;
import io.quarkus.kubernetes.client.runtime.KubernetesClientBuildConfig;
import io.quarkus.kubernetes.client.runtime.KubernetesConfigProducer;
import io.quarkus.runtime.TlsConfig;
import org.eclipse.microprofile.config.inject.ConfigProperty;
import javax.enterprise.inject.Alternative;
import javax.enterprise.inject.Produces;
import javax.inject.Singleton;
@Alternative
@Priority(1)
@Singleton
public class K3sConfigProducer extends KubernetesConfigProducer {
   //Injects the kubeConfigYaml that you've set in the K3sResource
   @ConfigProperty(name = "kubeConfigYaml")
   String kubeConfigYaml;
   //Returns the kubeConfigYaml as the config
   @Singleton
   @Produces
   public Config config(KubernetesClientBuildConfig buildConfig, TlsConfig tlsConfig) {
       return Config.fromKubeconfig(kubeConfigYaml);
   }
}

//Apply the oasis.yaml resource, which is a Game resource.
client.resources(Game.class).inNamespace(NAMESPACE)
       .load(getClass().getResource("/examples/oasis.yaml").getFile()).create();
//Get the Game instance for "oasis"
Game game = gameService.getGame("oasis", NAMESPACE);
//Assert the "oasis" game is not null.
Assert.assertNotNull(game);
//Postgres deployment and its being ready takes time.
//Wait for at most 60 seconds for the assertions.
await().atMost(60, TimeUnit.SECONDS).untilAsserted(() -> {
   //Get the Postgres deployment instance of the related game.
   Deployment postgresDeployment = gameService.getPostgresDeployment(game);
   //Assert the deployment object's being not null
   Assert.assertNotNull(postgresDeployment);
   //Assert if the deployment is ready
   Assert.assertEquals(Integer.valueOf(1), postgresDeployment.getStatus().getReadyReplicas());
   //Assert if the "oasis" game status is ready
   Assert.assertTrue(gameService.getGame(game.getMetadata().getName(), NAMESPACE).getStatus().isReady());
});

...output omitted...
2023-04-19 15:04:07,017 INFO  [org.tes.DockerClientFactory] (pool-4-thread-1) Connected to docker:
 Server Version: 20.10.21
 API Version: 1.41
 Operating System: Docker Desktop
 Total Memory: 7859 MB
2023-04-19 15:04:07,086 INFO  [Docker.3.4]] (pool-4-thread-1) Creating container for image: testcontainers/ryuk:0.3.4
...output ommited...
2023-04-19 15:04:33,390 INFO  [io.jav.ope.Operator] (main) Operator SDK 4.2.7 (commit: 5d8c567) built on Fri Feb 10 20:07:04 TRT 2023 starting...
2023-04-19 15:04:33,391 INFO  [io.jav.ope.Operator] (main) Client version: 6.3.1
2023-04-19 15:04:33,393 INFO  [io.jav.ope.pro.Controller] (Controller Starter for: gamereconciler) Starting 'gamereconciler' controller for reconciler: com.systemcraftsman.kubegame.reconciler.GameReconciler, resource: com.systemcraftsman.kubegame.customresource.Game
...output ommited...
Apr 19, 2023 3:05:26 PM io.quarkus.bootstrap.runner.Timing printStopTime
INFO: kubegame stopped in 0.045s
[INFO]
[INFO] Results:
[INFO]
[INFO] Tests run: 3, Failures: 0, Errors: 0, Skipped: 0
[INFO]
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time:  01:36 min
[INFO] Finished at: 2023-04-19T15:05:29+03:00
[INFO] ------------------------------------------------------------------------

//Apply the YAML resources for the worlds "archaide", "incipio", "chthonia"
client.resources(World.class).inNamespace(NAMESPACE)
   .load(getClass().getResource("/examples/archaide.yaml").getFile()).create();
client.resources(World.class).inNamespace(NAMESPACE)
   .load(getClass().getResource("/examples/incipio.yaml").getFile()).create();
client.resources(World.class).inNamespace(NAMESPACE)
   .load(getClass().getResource("/examples/chthonia.yaml").getFile()).create();
//Get the world instances "archaide", "incipio", "chthonia"
World worldArchaide = worldService.getWorld("archaide", NAMESPACE);
World worldIncipio = worldService.getWorld("incipio", NAMESPACE);
World worldChthonia = worldService.getWorld("chthonia", NAMESPACE);
//Assert the world instances checking they are not null
Assert.assertNotNull(worldArchaide);
Assert.assertNotNull(worldIncipio);
Assert.assertNotNull(worldChthonia);
//Assert the world instances expecting their status is "Ready"
//Wait for at most 60 seconds for the assertions.
await().atMost(60, TimeUnit.SECONDS).untilAsserted(() -> {
   Assert.assertTrue(worldService.getWorld(worldArchaide.getMetadata().getName(), NAMESPACE).getStatus().isReady());
   Assert.assertTrue(worldService.getWorld(worldIncipio.getMetadata().getName(), NAMESPACE).getStatus().isReady());
   Assert.assertTrue(worldService.getWorld(worldChthonia.getMetadata().getName(), NAMESPACE).getStatus().isReady());
});
//Get the game from one of the worlds
Game game = gameService.getGame(worldArchaide.getSpec().getGame(), worldArchaide.getMetadata().getNamespace());
//Run a select query against the postgres instance for the World table
ResultSet resultSet = postgresService.executeQuery(
   gameService.getPostgresServiceName(game) + ":" + GameService.POSTGRES_DB_PORT,
   "postgres", game.getSpec().getDatabase().getUsername(), game.getSpec().getDatabase().getPassword(),
   "SELECT * FROM World WHERE game=?",
   game.getMetadata().getName());
//Iterate over the result set and assert if the records are in the database
int resultCount = 0;
while(resultSet.next()){
   resultCount++;
}
Assert.assertEquals(3, resultCount);

...output omitted...
2023-04-19 15:55:02,003 WARN  [io.fab.kub.cli.dsl.int.VersionUsageUtils] (InformerWrapper [worlds.kubegame.systemcraftsman.com/v1alpha1] 142) The client is using resource type 'worlds' with unstable version 'v1alpha1'
2023-04-19 15:55:02,083 INFO  [io.jav.ope.pro.Controller] (Controller Starter for: worldreconciler) 'worldreconciler' controller started
...output omitted...
[INFO] Tests run: 3, Failures: 0, Errors: 0, Skipped: 0
[INFO]
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time:  01:40 min
[INFO] Finished at: 2023-04-19T15:56:04+03:00
[INFO] ------------------------------------------------------------------------

//Delete the worlds "archaide", "incipio", "chthonia"
client.resources(World.class).inNamespace(NAMESPACE)
   .load(getClass().getResource("/examples/archaide.yaml").getFile()).delete();
client.resources(World.class).inNamespace(NAMESPACE)
   .load(getClass().getResource("/examples/incipio.yaml").getFile()).delete();
client.resources(World.class).inNamespace(NAMESPACE)
   .load(getClass().getResource("/examples/chthonia.yaml").getFile()).delete();
//Assert the world instances are deleted
//Wait for at most 60 seconds for the assertions.
await().atMost(60, TimeUnit.SECONDS).untilAsserted(() -> {
   Assert.assertNull(worldService.getWorld("archaide", NAMESPACE));
   Assert.assertNull(worldService.getWorld("incipio", NAMESPACE));
   Assert.assertNull(worldService.getWorld("chthonia", NAMESPACE));
});
//Delete the "oasis" game
client.resources(Game.class).inNamespace(NAMESPACE)
   .load(getClass().getResource("/examples/oasis.yaml").getFile()).delete();
//Assert the game instance, its postgres instance and the service of it is deleted
//Wait for at most 60 seconds for the assertions.
await().atMost(60, TimeUnit.SECONDS).untilAsserted(() -> {
   Assert.assertNull(gameService.getGame("oasis", NAMESPACE));
   Assert.assertNull(client.apps().deployments().inNamespace(NAMESPACE).withName("oasis-postgres").get());
   Assert.assertNull(client.services().inNamespace(NAMESPACE).withName("oasis-postgres").get());
});

[INFO] Results:
[INFO]
[INFO] Tests run: 3, Failures: 0, Errors: 0, Skipped: 0
[INFO]
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time:  01:17 min
[INFO] Finished at: 2023-04-19T21:33:52+03:00
[INFO] ------------------------------------------------------------------------