review(crd-generator): process generated CRDs before they are written out

Signed-off-by: Marc Nuri <[email protected]>

Author: manusa

CHANGELOG.md

@@ -6,15 +6,13 @@
 * Fix #6892: rolling().restart() doesn't remove preexistent pod template annotations
 
 #### Improvements
-
 * Fix #6863: ensuring SerialExecutor does not throw RejectedExecutionException to prevent unnecessary error logs
 * Fix #6763: (crd-generator) YAML output customization
 
 #### Dependency Upgrade
 
 #### New Features
-
-* Fix #6827: Add CRDPostProcessor to process generated CRDs before they are written out
+* Fix #6827: (crd-generator) Add CRDPostProcessor to process generated CRDs before they are written out
 
 #### _**Note**_: Breaking changes
 

crd-generator/api-v2/src/main/java/io/fabric8/crdv2/generator/CRDGenerator.java

@@ -48,8 +48,6 @@
 public class CRDGenerator {
 
   private static final Logger LOGGER = LoggerFactory.getLogger(CRDGenerator.class);
-  private static final CRDPostProcessor nullProcessor = new CRDPostProcessor() {
-  };
   private final Map<String, AbstractCustomResourceHandler> handlers = new HashMap<>(2);
   private CRDOutput<? extends OutputStream> output;
   private boolean parallel;
@@ -58,7 +56,7 @@ public class CRDGenerator {
   private KubernetesSerialization kubernetesSerialization;
   private Map<String, CustomResourceInfo> infos;
   private boolean minQuotes = false;
-  private CRDPostProcessor postProcessor = nullProcessor;
+  private CRDPostProcessor postProcessor = CRDPostProcessor.nullProcessor;
 
   public CRDGenerator inOutputDir(File outputDir) {
     return withOutput(new DirCRDOutput(outputDir));

crd-generator/api-v2/src/main/java/io/fabric8/crdv2/generator/CRDPostProcessor.java

@@ -19,6 +19,9 @@
 
 public interface CRDPostProcessor {
 
+  CRDPostProcessor nullProcessor = new CRDPostProcessor() {
+  };
+
   /**
    * Processes the specified CRD (passed as {@link HasMetadata} to be able to handle multiple versions of the CRD spec) after
    * they are generated but before they are written out

crd-generator/api-v2/src/test/java/io/fabric8/crdv2/generator/CRDGeneratorTest.java

@@ -41,18 +41,20 @@
 import io.fabric8.kubernetes.client.utils.KubernetesSerialization;
 import io.fabric8.kubernetes.client.utils.Serialization;
 import io.fabric8.kubernetes.model.Scope;
+import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.RepeatedTest;
 import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.io.TempDir;
 import org.opentest4j.AssertionFailedError;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
 import java.io.ByteArrayInputStream;
 import java.io.ByteArrayOutputStream;
 import java.io.File;
-import java.io.FileInputStream;
 import java.net.URL;
 import java.nio.file.Files;
+import java.nio.file.Path;
 import java.util.ArrayList;
 import java.util.Collection;
 import java.util.List;
@@ -61,6 +63,7 @@
 import java.util.concurrent.ConcurrentHashMap;
 
 import static io.fabric8.crdv2.generator.CRDGeneratorAssertions.assertFileEquals;
+import static org.assertj.core.api.Assertions.assertThat;
 import static org.junit.jupiter.api.Assertions.assertEquals;
 import static org.junit.jupiter.api.Assertions.assertFalse;
 import static org.junit.jupiter.api.Assertions.assertNotNull;
@@ -70,8 +73,15 @@
 
 class CRDGeneratorTest {
 
-  private final TestCRDOutput output = new TestCRDOutput();
   protected boolean parallelCRDGeneration;
+  @TempDir
+  private File tempDir;
+  private TestCRDOutput output;
+
+  @BeforeEach
+  void setUp() {
+    output = new TestCRDOutput();
+  }
 
   @Test
   void choosingCRDVersionsShouldWork() {
@@ -458,12 +468,11 @@ void checkCRDGenerator() {
   }
 
   @Test
-  void checkGenerationIsDeterministic() throws Exception {
+  void checkGenerationIsDeterministic() {
     // generated CRD
-    final File outputDir = Files.createTempDirectory("crd-").toFile();
     final String crdName = CustomResourceInfo.fromClass(Complex.class).crdName();
     final CRDGenerationInfo crdInfo = newCRDGenerator()
-        .inOutputDir(outputDir)
+        .inOutputDir(tempDir)
         .forCRDVersions("v1")
         .customResourceClasses(Complex.class)
         .detailedGenerate();
@@ -475,37 +484,27 @@ void checkGenerationIsDeterministic() throws Exception {
     assertNotNull(crdResource);
     final File expectedCrdFile = new File(crdResource.getFile());
     assertFileEquals(expectedCrdFile, crdFile);
-
-    // only delete the generated files if the test is successful
-    assertTrue(crdFile.delete());
-    assertTrue(outputDir.delete());
   }
 
   @Test
   void checkMinQuotesDefault() throws Exception {
-    final File outputDir = Files.createTempDirectory("crd-").toFile();
     final String crdName = CustomResourceInfo.fromClass(Complex.class).crdName();
     CRDGenerationInfo crdInfo = newCRDGenerator()
-        .inOutputDir(outputDir)
+        .inOutputDir(tempDir)
         .forCRDVersions("v1")
         .customResourceClasses(Complex.class)
         .detailedGenerate();
 
     File crdFile = new File(crdInfo.getCRDInfos(crdName).get("v1").getFilePath());
     String crd = Files.readString(crdFile.toPath());
     assertTrue(crd.contains("\"complexkinds.example.com\""));
-
-    // only delete the generated files if the test is successful
-    assertTrue(crdFile.delete());
-    assertTrue(outputDir.delete());
   }
 
   @Test
   void checkMinQuotesFalse() throws Exception {
-    final File outputDir = Files.createTempDirectory("crd-").toFile();
     final String crdName = CustomResourceInfo.fromClass(Complex.class).crdName();
     CRDGenerationInfo crdInfo = newCRDGenerator()
-        .inOutputDir(outputDir)
+        .inOutputDir(tempDir)
         .forCRDVersions("v1")
         .customResourceClasses(Complex.class)
         .withMinQuotes(false)
@@ -514,18 +513,13 @@ void checkMinQuotesFalse() throws Exception {
     File crdFile = new File(crdInfo.getCRDInfos(crdName).get("v1").getFilePath());
     String crd = Files.readString(crdFile.toPath());
     assertTrue(crd.contains("\"complexkinds.example.com\""));
-
-    // only delete the generated files if the test is successful
-    assertTrue(crdFile.delete());
-    assertTrue(outputDir.delete());
   }
 
   @Test
   void checkMinQuotesTrue() throws Exception {
-    final File outputDir = Files.createTempDirectory("crd-").toFile();
     final String crdName = CustomResourceInfo.fromClass(Complex.class).crdName();
     CRDGenerationInfo crdInfo = newCRDGenerator()
-        .inOutputDir(outputDir)
+        .inOutputDir(tempDir)
         .forCRDVersions("v1")
         .customResourceClasses(Complex.class)
         .withMinQuotes(true)
@@ -535,23 +529,18 @@ void checkMinQuotesTrue() throws Exception {
     String crd = Files.readString(crdFile.toPath());
     assertTrue(crd.contains("complexkinds.example.com"));
     assertFalse(crd.contains("\"complexkinds.example.com\""));
-
-    // only delete the generated files if the test is successful
-    assertTrue(crdFile.delete());
-    assertTrue(outputDir.delete());
   }
 
   @RepeatedTest(value = 10)
   void checkGenerationMultipleVersionsOfCRDsIsDeterministic() throws Exception {
     // generated CRD
-    final File outputDir = Files.createTempDirectory("crd-").toFile();
     final CustomResourceInfo infoV1 = CustomResourceInfo.fromClass(Multiple.class);
     final CustomResourceInfo infoV2 = CustomResourceInfo.fromClass(io.fabric8.crdv2.example.multiple.v2.Multiple.class);
     assertEquals(infoV1.crdName(), infoV2.crdName());
     final String crdName = infoV1.crdName();
 
     final CRDGenerationInfo crdInfo = newCRDGenerator()
-        .inOutputDir(outputDir)
+        .inOutputDir(tempDir)
         .customResourceClasses(Multiple.class,
             io.fabric8.crdv2.example.multiple.v2.Multiple.class)
         .forCRDVersions("v1")
@@ -565,20 +554,15 @@ void checkGenerationMultipleVersionsOfCRDsIsDeterministic() throws Exception {
 
     final File expectedCrdFile = new File(crdResource.getFile());
     assertFileEquals(expectedCrdFile, crdFile);
-
-    // only delete the generated files if the test is successful
-    assertTrue(crdFile.delete());
-    assertTrue(outputDir.delete());
   }
 
   @Test
   void checkK8sValidationRules() throws Exception {
     // generated CRD
-    final File outputDir = Files.createTempDirectory("crd-").toFile();
     final String crdName = CustomResourceInfo.fromClass(K8sValidation.class).crdName();
 
     final CRDGenerationInfo crdInfo = newCRDGenerator()
-        .inOutputDir(outputDir)
+        .inOutputDir(tempDir)
         .customResourceClasses(K8sValidation.class)
         .forCRDVersions("v1")
         .detailedGenerate();
@@ -591,20 +575,15 @@ void checkK8sValidationRules() throws Exception {
 
     final File expectedCrdFile = new File(crdResource.getFile());
     assertFileEquals(expectedCrdFile, crdFile);
-
-    // only delete the generated files if the test is successful
-    assertTrue(crdFile.delete());
-    assertTrue(outputDir.delete());
   }
 
   @Test
   void checkPostProcessing() throws Exception {
     // generated CRD
-    final File outputDir = Files.createTempDirectory("crd-").toFile();
     final String crdName = CustomResourceInfo.fromClass(Simplest.class).crdName();
 
     final CRDGenerationInfo crdInfo = newCRDGenerator()
-        .inOutputDir(outputDir)
+        .inOutputDir(tempDir)
         .customResourceClasses(Simplest.class)
         .forCRDVersions("v1")
         .withPostProcessor(new CRDPostProcessor() {
@@ -617,16 +596,10 @@ public HasMetadata process(HasMetadata crd, String crdSpecVersion) {
         })
         .detailedGenerate();
 
-    final File crdFile = new File(crdInfo.getCRDInfos(crdName).get("v1").getFilePath());
-    final var serialization = new KubernetesSerialization();
-    final var crd = serialization.unmarshal(new FileInputStream(crdFile), HasMetadata.class);
-    assertNotNull(crd);
-    assertEquals(crdName, crd.getMetadata().getName());
-    assertEquals("bar", crd.getMetadata().getLabels().get("foo"));
-
-    // only delete the generated files if the test is successful
-    assertTrue(crdFile.delete());
-    assertTrue(outputDir.delete());
+    assertThat(new KubernetesSerialization().unmarshal(
+        Files.newInputStream(Path.of(crdInfo.getCRDInfos(crdName).get("v1").getFilePath())), HasMetadata.class))
+        .hasFieldOrPropertyWithValue("metadata.name", crdName)
+        .hasFieldOrPropertyWithValue("metadata.labels.foo", "bar");
   }
 
   private CustomResourceDefinitionVersion checkCRD(Class<? extends CustomResource<?, ?>> customResource, String kind,