feat(interu): Add --check-test-options flag (#30)

Author: Techassi

tools/interu/fixtures/interu.yaml

@@ -6,7 +6,7 @@ runners:
       - name: default
         arch: amd64
         size: large
-        disk: 50
+        disk-gb: 50
         nodes: 3
 
   default-arm64:
@@ -16,7 +16,7 @@ runners:
       - name: default
         arch: arm64
         size: large
-        disk: 50
+        disk-gb: 50
         nodes: 3
 
   default-mixed:
@@ -26,12 +26,12 @@ runners:
       - name: amd64-nodes
         arch: amd64
         size: large
-        disk: 50
+        disk-gb: 50
         nodes: 3
       - name: arm64-nodes
         arch: arm64
         size: large
-        disk: 50
+        disk-gb: 50
         nodes: 3
 
 profiles:

tools/interu/fixtures/test-definition.yaml

@@ -0,0 +1,98 @@
+# COPIED FROM AIRFLOW-OPERATOR
+---
+dimensions:
+  - name: airflow
+    values:
+      - 2.9.2
+      - 2.9.3
+      - 2.10.2
+      # To use a custom image, add a comma and the full name after the product version
+      # - 2.8.1,docker.stackable.tech/sandbox/airflow:2.8.1-stackable0.0.0-dev
+  - name: airflow-latest
+    values:
+      - 2.10.2
+      # To use a custom image, add a comma and the full name after the product version
+      # - 2.8.1,docker.stackable.tech/sandbox/airflow:2.8.1-stackable0.0.0-dev
+  - name: ldap-authentication
+    values:
+      - no-tls
+      - insecure-tls
+      - server-verification-tls
+  - name: openshift
+    values:
+      - "false"
+  - name: executor
+    values:
+      - celery
+      - kubernetes
+tests:
+  - name: smoke
+    dimensions:
+      - airflow
+      - openshift
+      - executor
+  - name: mount-dags-configmap
+    dimensions:
+      - airflow-latest
+      - openshift
+      - executor
+  - name: mount-dags-gitsync
+    dimensions:
+      - airflow-latest
+      - openshift
+      - executor
+  - name: ldap
+    dimensions:
+      - airflow-latest
+      - openshift
+      - ldap-authentication
+      - executor
+  - name: oidc
+    dimensions:
+      - airflow
+      - openshift
+  - name: resources
+    dimensions:
+      - airflow-latest
+      - openshift
+  - name: orphaned-resources
+    dimensions:
+      - airflow-latest
+      - openshift
+  - name: logging
+    dimensions:
+      - airflow
+      - openshift
+      - executor
+  - name: cluster-operation
+    dimensions:
+      - airflow-latest
+      - openshift
+  - name: overrides
+    dimensions:
+      - airflow-latest
+      - openshift
+suites:
+  - name: nightly
+    # Run nightly with the latest airflow
+    patch:
+      - dimensions:
+          - name: airflow
+            expr: last
+  - name: smoke-latest
+    # Useful for development
+    select:
+      - smoke
+    patch:
+      - dimensions:
+          - expr: last
+  - name: openshift
+    # Run on OpenShift with latest airflow
+    patch:
+      - dimensions:
+          - expr: last
+      - dimensions:
+          - name: airflow
+            expr: last
+          - name: openshift
+            expr: "true"

tools/interu/src/cli.rs

@@ -23,8 +23,7 @@ pub struct Cli {
         option,
         short = 'o',
         long = "output",
-        description = "write configuration key=value pairs separated by newlines to file
-    Useful for CI tools which give a file to write env vars and outputs to which are used in subsequent steps"
+        description = "write configuration key=value pairs separated by newlines to file. Useful for CI tools which give a file to write env vars and outputs to which are used in subsequent steps"
     )]
     pub output: Option<PathBuf>,
 
@@ -33,6 +32,19 @@ pub struct Cli {
     #[argh(switch, short = 'q', long = "quiet")]
     pub quiet: bool,
 
+    /// validate the beku test definition of the selected profile
+    #[argh(switch, long = "check-test-definitions")]
+    pub check_test_definitions: bool,
+
+    /// path to beku test-definition file [default = tests/test-definition.yaml]
+    #[argh(
+        option,
+        short = 't',
+        long = "test-definitions",
+        default = r#"PathBuf::from("tests/test-definition.yaml")"#
+    )]
+    pub test_definitions: PathBuf,
+
     /// which test profile to use
     #[argh(positional)]
     pub profile: String,

tools/interu/src/config/mod.rs

@@ -11,7 +11,7 @@ use tracing::instrument;
 
 use crate::{
     config::{
-        profile::{Profile, StrategyValidationError, TestRun},
+        profile::{Profile, StrategyValidationError, TestOptions, TestRun},
         runner::{
             ConvertNodeGroupError, Distribution, ReplicatedNodeGroup, Runner, RunnerValidationError,
         },
@@ -21,6 +21,7 @@ use crate::{
 
 pub mod profile;
 pub mod runner;
+pub mod test;
 
 /// Errors which can be encountered when reading and validating the config file.
 #[derive(Debug, Snafu)]
@@ -43,6 +44,9 @@ pub enum Error {
         path: PathBuf,
     },
 
+    #[snafu(display("failed to validate test options"))]
+    ValidateTestOptions { source: StrategyValidationError },
+
     #[snafu(display("failed to find profile named {profile_name:?}"))]
     UnknownProfileName { profile_name: String },
 
@@ -92,25 +96,19 @@ impl Config {
         Ok(config)
     }
 
-    #[instrument(name = "validate_config", skip(self))]
-    fn validate(&self) -> Result<(), ValidationError> {
-        for (runner_name, runner) in &self.runners {
-            tracing::debug!(runner_name, "validate runner");
-
-            runner
-                .validate(runner_name)
-                .context(InvalidRunnerConfigSnafu)?;
-        }
-
-        for (profile_name, profile) in &self.profiles {
-            tracing::debug!(profile_name, "validate profile");
-
-            profile
-                .validate(profile_name, &self.runners)
-                .context(InvalidProfileConfigSnafu)?;
-        }
+    pub fn get_profile(&self, profile_name: &String) -> Result<&Profile, Error> {
+        self.profiles
+            .get(profile_name)
+            .context(UnknownProfileNameSnafu { profile_name })
+    }
 
-        Ok(())
+    pub fn validate_test_options<P>(&self, profile_name: &String, path: P) -> Result<(), Error>
+    where
+        P: AsRef<Path>,
+    {
+        self.get_profile(profile_name)?
+            .validate_test_options(&profile_name, path)
+            .context(ValidateTestOptionsSnafu)
     }
 
     /// Determines the final expanded parameters based on the provided profile.
@@ -120,10 +118,7 @@ impl Config {
         instances: &'a Instances,
     ) -> Result<Parameters<'a>, Error> {
         // First, lookup the profile by name. Error if the profile does't exist.
-        let profile = self
-            .profiles
-            .get(profile_name)
-            .context(UnknownProfileNameSnafu { profile_name })?;
+        let profile = self.get_profile(profile_name)?;
 
         // Next, lookup the runner ref based on the profile strategy
         let runner_ref = match &profile.strategy {
@@ -144,7 +139,11 @@ impl Config {
         let runner = self.runners.get(runner_ref).unwrap();
 
         // Get test options
-        let (test_parallelism, test_run, test_parameter) = profile.strategy.get_test_options();
+        let TestOptions {
+            parallelism,
+            test_run,
+            test_parameter,
+        } = profile.strategy.get_test_options();
 
         // Convert our node groups to replicated node groups
         let node_groups = runner
@@ -158,13 +157,34 @@ impl Config {
         Ok(Parameters {
             kubernetes_distribution: &runner.platform.distribution,
             kubernetes_version: &runner.platform.version,
+            test_parallelism: *parallelism,
             cluster_ttl: &runner.ttl,
-            test_parallelism,
             test_parameter,
             node_groups,
             test_run,
         })
     }
+
+    #[instrument(name = "validate_config", skip(self))]
+    fn validate(&self) -> Result<(), ValidationError> {
+        for (runner_name, runner) in &self.runners {
+            tracing::debug!(runner_name, "validate runner");
+
+            runner
+                .validate(runner_name)
+                .context(InvalidRunnerConfigSnafu)?;
+        }
+
+        for (profile_name, profile) in &self.profiles {
+            tracing::debug!(profile_name, "validate profile");
+
+            profile
+                .validate(profile_name, &self.runners)
+                .context(InvalidProfileConfigSnafu)?;
+        }
+
+        Ok(())
+    }
 }
 
 /// Parameters which will be expanded into environment variables via the [`Display`] implementation.
@@ -221,7 +241,7 @@ impl<'a> Display for Parameters<'a> {
 }
 
 #[cfg(test)]
-mod test {
+mod tests {
     use std::path::PathBuf;
 
     use super::*;