add more devfile tests

metio · Nov 26, 2022 · 33ceaa3 · 33ceaa3
1 parent 3825dc9
commit 33ceaa3
Show file tree

Hide file tree

Showing 5 changed files with 315 additions and 0 deletions.
diff --git a/src/main/java/wtf/metio/ilo/Ilo.java b/src/main/java/wtf/metio/ilo/Ilo.java
@@ -12,6 +12,7 @@
 import wtf.metio.ilo.cli.RunCommands;
 import wtf.metio.ilo.compose.Compose;
 import wtf.metio.ilo.devcontainer.Devcontainer;
+import wtf.metio.ilo.devfile.Devfile;
 import wtf.metio.ilo.errors.ExitCodes;
 import wtf.metio.ilo.errors.PrintingExceptionHandler;
 import wtf.metio.ilo.shell.Shell;
@@ -40,6 +41,7 @@
     Shell.class,
     Compose.class,
     Devcontainer.class,
+    Devfile.class,
     AutoComplete.GenerateCompletion.class
   },
   showDefaultValues = true

diff --git a/src/test/java/wtf/metio/ilo/acceptance/CLI_TCK.java b/src/test/java/wtf/metio/ilo/acceptance/CLI_TCK.java
@@ -12,6 +12,7 @@
 import wtf.metio.ilo.Ilo;
 import wtf.metio.ilo.compose.Compose;
 import wtf.metio.ilo.devcontainer.Devcontainer;
+import wtf.metio.ilo.devfile.Devfile;
 import wtf.metio.ilo.shell.Shell;
 import wtf.metio.ilo.test.TestMethodSources;
 
@@ -48,4 +49,10 @@ protected final Devcontainer parseDevcontainerCommand(final String... args) {
     return (Devcontainer) subcommand.commandSpec().userObject();
   }
 
+  protected final Devfile parseDevfileCommand(final String... args) {
+    final var parseResult = cmd.parseArgs(args);
+    final var subcommand = parseResult.subcommand();
+    return (Devfile) subcommand.commandSpec().userObject();
+  }
+
 }
diff --git a/src/test/java/wtf/metio/ilo/acceptance/DevfileAcceptanceTest.java b/src/test/java/wtf/metio/ilo/acceptance/DevfileAcceptanceTest.java
@@ -0,0 +1,265 @@
+/*
+ * This file is part of ilo. It is subject to the license terms in the LICENSE file found in the top-level
+ * directory of this distribution and at https://creativecommons.org/publicdomain/zero/1.0/. No part of ilo,
+ * including this file, may be copied, modified, propagated, or distributed except according to the terms contained
+ * in the LICENSE file.
+ */
+
+package wtf.metio.ilo.acceptance;
+
+import org.junit.jupiter.api.Assertions;
+import org.junit.jupiter.api.DisplayName;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.MethodSource;
+import org.junit.jupiter.params.provider.ValueSource;
+import wtf.metio.ilo.shell.ShellRuntime;
+
+import java.util.List;
+
+import static org.junit.jupiter.api.Assertions.*;
+
+@DisplayName("ilo devfile")
+class DevfileAcceptanceTest extends CLI_TCK {
+
+  private static final List<String> DEFAULT_LOCATIONS = List.of("devfile.yaml", ".devfile.yaml");
+
+  @ParameterizedTest
+  @DisplayName("version info")
+  @ValueSource(strings = {"-V", "--version"})
+  void shouldSupportVersionOption(final String flag) {
+    final var exitCode = cmd.execute(flag);
+    Assertions.assertEquals(0, exitCode);
+    Assertions.assertTrue(output.toString().startsWith("ilo: "));
+  }
+
+  @Test
+  @DisplayName("default command line options")
+  void defaultCommandLine() {
+    final var devfile = parseDevfileCommand("devfile");
+    assertAll("devfile options",
+        () -> assertFalse(devfile.options.debug, "debug"),
+        () -> assertFalse(devfile.options.removeImage, "removeImage"),
+        () -> assertFalse(devfile.options.pull, "pull"),
+        () -> assertNull(devfile.options.runtimeOptions, "runtimeOptions"),
+        () -> assertNull(devfile.options.runtimePullOptions, "runtimePullOptions"),
+        () -> assertNull(devfile.options.runtimeBuildOptions, "runtimeBuildOptions"),
+        () -> assertNull(devfile.options.runtimeRunOptions, "runtimeRunOptions"),
+        () -> assertNull(devfile.options.runtimeCleanupOptions, "runtimeCleanupOptions"),
+        () -> assertIterableEquals(DEFAULT_LOCATIONS, devfile.options.locations, "locations")
+    );
+  }
+
+  @Test
+  @DisplayName("custom devfile.yaml location")
+  void customLocation() {
+    final var devfile = parseDevfileCommand("devfile", "somewhere.yaml");
+    assertAll("devfile options",
+        () -> assertFalse(devfile.options.debug, "debug"),
+        () -> assertFalse(devfile.options.removeImage, "removeImage"),
+        () -> assertFalse(devfile.options.pull, "pull"),
+        () -> assertNull(devfile.options.runtimeOptions, "runtimeOptions"),
+        () -> assertNull(devfile.options.runtimePullOptions, "runtimePullOptions"),
+        () -> assertNull(devfile.options.runtimeBuildOptions, "runtimeBuildOptions"),
+        () -> assertNull(devfile.options.runtimeRunOptions, "runtimeRunOptions"),
+        () -> assertNull(devfile.options.runtimeCleanupOptions, "runtimeCleanupOptions"),
+        () -> assertIterableEquals(List.of("somewhere.yaml"), devfile.options.locations, "locations")
+    );
+  }
+
+  @Test
+  @DisplayName("custom devfile.yaml locations")
+  void customLocations() {
+    final var devfile = parseDevfileCommand("devfile", "somewhere.yaml", "other.yaml");
+    assertAll("devfile options",
+        () -> assertFalse(devfile.options.debug, "debug"),
+        () -> assertFalse(devfile.options.removeImage, "removeImage"),
+        () -> assertFalse(devfile.options.pull, "pull"),
+        () -> assertNull(devfile.options.runtimeOptions, "runtimeOptions"),
+        () -> assertNull(devfile.options.runtimePullOptions, "runtimePullOptions"),
+        () -> assertNull(devfile.options.runtimeBuildOptions, "runtimeBuildOptions"),
+        () -> assertNull(devfile.options.runtimeRunOptions, "runtimeRunOptions"),
+        () -> assertNull(devfile.options.runtimeCleanupOptions, "runtimeCleanupOptions"),
+        () -> assertIterableEquals(List.of("somewhere.yaml", "other.yaml"), devfile.options.locations, "locations")
+    );
+  }
+
+  @Test
+  @DisplayName("allows to enable debugging")
+  void enableDebug() {
+    final var devfile = parseDevfileCommand("devfile", "--debug=true");
+    assertAll("devfile options",
+        () -> assertTrue(devfile.options.debug, "debug"),
+        () -> assertFalse(devfile.options.removeImage, "removeImage"),
+        () -> assertFalse(devfile.options.pull, "pull"),
+        () -> assertNull(devfile.options.runtimeOptions, "runtimeOptions"),
+        () -> assertNull(devfile.options.runtimePullOptions, "runtimePullOptions"),
+        () -> assertNull(devfile.options.runtimeBuildOptions, "runtimeBuildOptions"),
+        () -> assertNull(devfile.options.runtimeRunOptions, "runtimeRunOptions"),
+        () -> assertNull(devfile.options.runtimeCleanupOptions, "runtimeCleanupOptions"),
+        () -> assertIterableEquals(DEFAULT_LOCATIONS, devfile.options.locations, "locations")
+    );
+  }
+
+  @Test
+  @DisplayName("allows to remove images after exit")
+  void removeImage() {
+    final var devfile = parseDevfileCommand("devfile", "--remove-image=true");
+    assertAll("devfile options",
+        () -> assertFalse(devfile.options.debug, "debug"),
+        () -> assertTrue(devfile.options.removeImage, "removeImage"),
+        () -> assertFalse(devfile.options.pull, "pull"),
+        () -> assertNull(devfile.options.runtimeOptions, "runtimeOptions"),
+        () -> assertNull(devfile.options.runtimePullOptions, "runtimePullOptions"),
+        () -> assertNull(devfile.options.runtimeBuildOptions, "runtimeBuildOptions"),
+        () -> assertNull(devfile.options.runtimeRunOptions, "runtimeRunOptions"),
+        () -> assertNull(devfile.options.runtimeCleanupOptions, "runtimeCleanupOptions"),
+        () -> assertIterableEquals(DEFAULT_LOCATIONS, devfile.options.locations, "locations")
+    );
+  }
+
+  @Test
+  @DisplayName("allows to pull images before run")
+  void pullImage() {
+    final var devfile = parseDevfileCommand("devfile", "--pull=true");
+    assertAll("devfile options",
+        () -> assertFalse(devfile.options.debug, "debug"),
+        () -> assertFalse(devfile.options.removeImage, "removeImage"),
+        () -> assertTrue(devfile.options.pull, "pull"),
+        () -> assertNull(devfile.options.runtimeOptions, "runtimeOptions"),
+        () -> assertNull(devfile.options.runtimePullOptions, "runtimePullOptions"),
+        () -> assertNull(devfile.options.runtimeBuildOptions, "runtimeBuildOptions"),
+        () -> assertNull(devfile.options.runtimeRunOptions, "runtimeRunOptions"),
+        () -> assertNull(devfile.options.runtimeCleanupOptions, "runtimeCleanupOptions"),
+        () -> assertIterableEquals(DEFAULT_LOCATIONS, devfile.options.locations, "locations")
+    );
+  }
+
+  @Test
+  @DisplayName("allows to specify component")
+  void component() {
+    final var devfile = parseDevfileCommand("devfile", "--component=some-name");
+    assertAll("devfile options",
+        () -> assertFalse(devfile.options.debug, "debug"),
+        () -> assertFalse(devfile.options.removeImage, "removeImage"),
+        () -> assertFalse(devfile.options.pull, "pull"),
+        () -> assertNull(devfile.options.runtimeOptions, "runtimeOptions"),
+        () -> assertNull(devfile.options.runtimePullOptions, "runtimePullOptions"),
+        () -> assertNull(devfile.options.runtimeBuildOptions, "runtimeBuildOptions"),
+        () -> assertNull(devfile.options.runtimeRunOptions, "runtimeRunOptions"),
+        () -> assertNull(devfile.options.runtimeCleanupOptions, "runtimeCleanupOptions"),
+        () -> assertEquals("some-name", devfile.options.component, "component"),
+        () -> assertIterableEquals(DEFAULT_LOCATIONS, devfile.options.locations, "locations")
+    );
+  }
+
+  @ParameterizedTest
+  @MethodSource("shellRuntimes")
+  @DisplayName("allows to specify runtime options")
+  void runtimeOptions(final String tool) {
+    final var devfile = parseDevfileCommand("devfile", "--runtime", tool, "--runtime-option=--remote");
+    assertAll("devfile options",
+        () -> assertEquals(ShellRuntime.fromAlias(tool), devfile.options.runtime, "runtime"),
+        () -> assertFalse(devfile.options.debug, "debug"),
+        () -> assertFalse(devfile.options.removeImage, "removeImage"),
+        () -> assertIterableEquals(List.of("--remote"), devfile.options.runtimeOptions, "runtimeOptions"),
+        () -> assertNull(devfile.options.runtimePullOptions, "runtimePullOptions"),
+        () -> assertNull(devfile.options.runtimeBuildOptions, "runtimeBuildOptions"),
+        () -> assertNull(devfile.options.runtimeRunOptions, "runtimeRunOptions"),
+        () -> assertNull(devfile.options.runtimeCleanupOptions, "runtimeCleanupOptions"),
+        () -> assertIterableEquals(DEFAULT_LOCATIONS, devfile.options.locations, "locations")
+    );
+  }
+
+  @ParameterizedTest
+  @MethodSource("shellRuntimes")
+  @DisplayName("allows to specify runtime pull options")
+  void runtimePullOptions(final String tool) {
+    final var devfile = parseDevfileCommand("devfile", "--runtime", tool, "--runtime-pull-option=--all-tags");
+    assertAll("devfile options",
+        () -> assertEquals(ShellRuntime.fromAlias(tool), devfile.options.runtime, "runtime"),
+        () -> assertFalse(devfile.options.debug, "debug"),
+        () -> assertFalse(devfile.options.removeImage, "removeImage"),
+        () -> assertNull(devfile.options.runtimeOptions, "runtimeOptions"),
+        () -> assertIterableEquals(List.of("--all-tags"), devfile.options.runtimePullOptions, "runtimePullOptions"),
+        () -> assertNull(devfile.options.runtimeBuildOptions, "runtimeBuildOptions"),
+        () -> assertNull(devfile.options.runtimeRunOptions, "runtimeRunOptions"),
+        () -> assertNull(devfile.options.runtimeCleanupOptions, "runtimeCleanupOptions"),
+        () -> assertIterableEquals(DEFAULT_LOCATIONS, devfile.options.locations, "locations")
+    );
+  }
+
+  @ParameterizedTest
+  @MethodSource("shellRuntimes")
+  @DisplayName("allows to specify runtime build options")
+  void runtimeBuildOptions(final String tool) {
+    final var devfile = parseDevfileCommand("devfile", "--runtime", tool, "--runtime-build-option=--no-cache");
+    assertAll("devfile options",
+        () -> assertEquals(ShellRuntime.fromAlias(tool), devfile.options.runtime, "runtime"),
+        () -> assertFalse(devfile.options.debug, "debug"),
+        () -> assertFalse(devfile.options.removeImage, "removeImage"),
+        () -> assertNull(devfile.options.runtimeOptions, "runtimeOptions"),
+        () -> assertNull(devfile.options.runtimePullOptions, "runtimePullOptions"),
+        () -> assertIterableEquals(List.of("--no-cache"), devfile.options.runtimeBuildOptions, "runtimeBuildOptions"),
+        () -> assertNull(devfile.options.runtimeRunOptions, "runtimeRunOptions"),
+        () -> assertNull(devfile.options.runtimeCleanupOptions, "runtimeCleanupOptions"),
+        () -> assertIterableEquals(DEFAULT_LOCATIONS, devfile.options.locations, "locations")
+    );
+  }
+
+  @ParameterizedTest
+  @MethodSource("shellRuntimes")
+  @DisplayName("allows to specify runtime run options")
+  void runtimeRunOptions(final String tool) {
+    final var devfile = parseDevfileCommand("devfile", "--runtime", tool, "--runtime-run-option=--no-hosts");
+    assertAll("devfile options",
+        () -> assertEquals(ShellRuntime.fromAlias(tool), devfile.options.runtime, "runtime"),
+        () -> assertFalse(devfile.options.debug, "debug"),
+        () -> assertFalse(devfile.options.removeImage, "removeImage"),
+        () -> assertNull(devfile.options.runtimeOptions, "runtimeOptions"),
+        () -> assertNull(devfile.options.runtimePullOptions, "runtimePullOptions"),
+        () -> assertNull(devfile.options.runtimeBuildOptions, "runtimeBuildOptions"),
+        () -> assertIterableEquals(List.of("--no-hosts"), devfile.options.runtimeRunOptions, "runtimeRunOptions"),
+        () -> assertNull(devfile.options.runtimeCleanupOptions, "runtimeCleanupOptions"),
+        () -> assertIterableEquals(DEFAULT_LOCATIONS, devfile.options.locations, "locations")
+    );
+  }
+
+  @ParameterizedTest
+  @MethodSource("shellRuntimes")
+  @DisplayName("allows to specify runtime cleanup options")
+  void runtimeCleanupOptions(final String tool) {
+    final var devfile = parseDevfileCommand("devfile", "--runtime", tool, "--runtime-cleanup-option=--force");
+    assertAll("devfile options",
+        () -> assertEquals(ShellRuntime.fromAlias(tool), devfile.options.runtime, "runtime"),
+        () -> assertFalse(devfile.options.debug, "debug"),
+        () -> assertFalse(devfile.options.removeImage, "removeImage"),
+        () -> assertNull(devfile.options.runtimeOptions, "runtimeOptions"),
+        () -> assertNull(devfile.options.runtimePullOptions, "runtimePullOptions"),
+        () -> assertNull(devfile.options.runtimeBuildOptions, "runtimeBuildOptions"),
+        () -> assertNull(devfile.options.runtimeRunOptions, "runtimeRunOptions"),
+        () -> assertIterableEquals(List.of("--force"), devfile.options.runtimeCleanupOptions, "runtimeCleanupOptions"),
+        () -> assertIterableEquals(DEFAULT_LOCATIONS, devfile.options.locations, "locations")
+    );
+  }
+
+  @ParameterizedTest
+  @MethodSource("shellRuntimes")
+  @DisplayName("supports multiple devfile runtimes")
+  void selectRuntime(final String runtime) {
+    final var devfile = parseDevfileCommand("devfile", "--runtime=" + runtime);
+    assertAll("devfile options",
+        () -> assertEquals(ShellRuntime.fromAlias(runtime), devfile.options.runtime, "runtime"),
+        () -> assertFalse(devfile.options.debug, "debug"),
+        () -> assertFalse(devfile.options.removeImage, "removeImage"),
+        () -> assertFalse(devfile.options.pull, "pull"),
+        () -> assertNull(devfile.options.runtimeOptions, "runtimeOptions"),
+        () -> assertNull(devfile.options.runtimePullOptions, "runtimePullOptions"),
+        () -> assertNull(devfile.options.runtimeBuildOptions, "runtimeBuildOptions"),
+        () -> assertNull(devfile.options.runtimeRunOptions, "runtimeRunOptions"),
+        () -> assertNull(devfile.options.runtimeCleanupOptions, "runtimeCleanupOptions"),
+        () -> assertIterableEquals(DEFAULT_LOCATIONS, devfile.options.locations, "locations")
+    );
+  }
+
+}
diff --git a/src/test/java/wtf/metio/ilo/devfile/DevfileOptionsTest.java b/src/test/java/wtf/metio/ilo/devfile/DevfileOptionsTest.java
@@ -31,6 +31,14 @@ void shouldHaveDefaultConstructor() throws NoSuchMethodException {
   @DisplayName("has public fields")
   @ValueSource(strings = {
       "runtime",
+      "runtimeOptions",
+      "runtimePullOptions",
+      "runtimeRunOptions",
+      "runtimeBuildOptions",
+      "runtimeCleanupOptions",
+      "removeImage",
+      "component",
+      "pull",
       "debug",
       "locations"
   })

diff --git a/src/test/java/wtf/metio/ilo/devfile/DevfileTest.java b/src/test/java/wtf/metio/ilo/devfile/DevfileTest.java
@@ -45,4 +45,37 @@ void shouldSupportLocalDockerfile() {
     assertTrue(Devfile.hasSupportedDevfileConfiguration(devfile, "image"));
   }
 
+  @Test
+  void shouldNotSupportGitDockerfile() {
+    final var devfile = new DevfileYaml();
+    final var image = new DevfileYaml.Image();
+    final var dockerfile = new DevfileYaml.Dockerfile();
+    dockerfile.git = new DevfileYaml.Git();
+    dockerfile.git.checkoutFrom = new DevfileYaml.CheckoutFrom();
+    dockerfile.git.checkoutFrom.remote = "origin";
+    dockerfile.git.checkoutFrom.revision = "HEAD";
+    image.dockerfile = dockerfile;
+    final var component = new DevfileYaml.Component();
+    component.name = "image";
+    component.image = image;
+    devfile.components = List.of(component);
+
+    assertFalse(Devfile.hasSupportedDevfileConfiguration(devfile, "image"));
+  }
+
+  @Test
+  void shouldMapPredefinedImages() {
+    final var devfile = new DevfileYaml();
+    final var container = new DevfileYaml.Container();
+    container.image = "docker.io/library/maven:latest";
+    final var component = new DevfileYaml.Component();
+    component.name = "container";
+    component.container = container;
+    devfile.components = List.of(component);
+    final var options = new DevfileOptions();
+    final var shellOptions = Devfile.mapOptions(options, devfile);
+
+    assertEquals("docker.io/library/maven:latest", shellOptions.image);
+  }
+
 }