config: introduce new config format and parser

For supporting multiple deployments in one cnf and improving overall config usability and structure - new config format has to be introduced. Some existing parameters usage need to be changed for easier adaptation. This change does not replace the old config format. Refs: cnti-testcatalog#2121 Signed-off-by: Konstantin Yarovoy <[email protected]>
kosstennbl · Sep 5, 2024 · f1c5d67 · f1c5d67
1 parent c0f461e
commit f1c5d67
Show file tree

Hide file tree

Showing 61 changed files with 315 additions and 134 deletions.
diff --git a/embedded_files/cnf-testsuite-v2-example.yml b/embedded_files/cnf-testsuite-v2-example.yml
@@ -0,0 +1,23 @@
+---
+config_version: "v2"
+common: 
+  container_names:
+    - name: coredns
+      rolling_update_test_tag: "1.8.0"
+      rolling_downgrade_test_tag: 1.6.7
+      rolling_version_change_test_tag: 1.8.0
+      rollback_from_tag: 1.8.0
+
+deployments:
+  helm_charts:
+    - name: coredns
+      helm_repo_name: stable
+      helm_repo_url: https://cncf.gitlab.io/stable
+      helm_chart_name: coredns
+#  helm_dirs:
+#    - name: envoy
+#      helm_directory: ../example-cnfs/envoy/envoy
+#  manifests:
+#    - name: nginx
+#      manifest_directory: manifests
+
diff --git a/example-cnfs/envoy/cnf-testsuite.yml b/example-cnfs/envoy/cnf-testsuite.yml
@@ -1,4 +1,3 @@
 ---
 release_name: envoy 
-service_name: envoy
 helm_directory: envoy
diff --git a/example-cnfs/ip-forwarder/cnf-testsuite.yml b/example-cnfs/ip-forwarder/cnf-testsuite.yml
@@ -1,6 +1,5 @@
 ---
 helm_directory: vpp
 release_name: vpp
-service_name: ""
 rolling_update_test_tag: latest
 allowlist_helm_chart_container_names: [nginx, calico-node, kube-proxy, nginx-proxy, node-cache, kube-multus]
diff --git a/example-cnfs/nsm/cnf-testsuite.yml b/example-cnfs/nsm/cnf-testsuite.yml
@@ -1,7 +1,6 @@
 ---
 helm_directory: helm_chart
 release_name: nsm --set insecure=true
-service_name: nsm-admission-webhook-svc
 helm_repository:
   name: stable 
   repo_url: https://cncf.gitlab.io/stable
diff --git a/example-cnfs/pantheon-nsm-nat/cnf-testsuite.yml b/example-cnfs/pantheon-nsm-nat/cnf-testsuite.yml
@@ -1,5 +1,4 @@
 ---
 helm_directory: nat-cnf 
 release_name: cnf-nat 
-service_name: 
 allowlist_helm_chart_container_names: [node-cache, nginx, coredns, calico-node, kube-proxy, nginx-proxy, kube-multus]
diff --git a/sample-cnfs/k8s-multiple-deployments/cnf-testsuite.yml b/sample-cnfs/k8s-multiple-deployments/cnf-testsuite.yml
@@ -1,7 +1,6 @@
 ---
 helm_directory: chart
 release_name: sidecar-container-demo
-service_name: 
 helm_repository:
   name: stable 
   repo_url: https://cncf.gitlab.io/stable
diff --git a/sample-cnfs/k8s-multiple-processes/cnf-testsuite.yml b/sample-cnfs/k8s-multiple-processes/cnf-testsuite.yml
@@ -1,7 +1,6 @@
 ---
 helm_directory: chart
 release_name: sidecar-container-demo
-service_name: 
 helm_repository:
   name: stable 
   repo_url: https://cncf.gitlab.io/stable

diff --git a/sample-cnfs/k8s-sidecar-container-pattern/cnf-testsuite.yml b/sample-cnfs/k8s-sidecar-container-pattern/cnf-testsuite.yml
@@ -3,7 +3,6 @@ helm_directory: chart
 git_clone_url: 
 install_script: 
 release_name: sidecar-container-demo
-service_name: 
 helm_repository:
   name: stable 
   repo_url: https://cncf.gitlab.io/stable

diff --git a/sample-cnfs/sample-bad-helm-repo/cnf-testsuite.yml b/sample-cnfs/sample-bad-helm-repo/cnf-testsuite.yml
@@ -1,6 +1,5 @@
 ---
 release_name: coredns
-service_name: coredns-coredns 
 helm_repository:
   name: badrepo
   repo_url: https://bad-helm-repo.googleapis.com

diff --git a/sample-cnfs/sample-bad-zombie/cnf-testsuite.yml b/sample-cnfs/sample-bad-zombie/cnf-testsuite.yml
@@ -1,6 +1,5 @@
 ---
 release_name: coredns
-service_name: coredns-coredns 
 helm_repository:
   name: stable 
   repo_url: https://cncf.gitlab.io/stable

diff --git a/sample-cnfs/sample-bad_helm_coredns-cnf/cnf-testsuite.yml b/sample-cnfs/sample-bad_helm_coredns-cnf/cnf-testsuite.yml
@@ -1,4 +1,3 @@
 ---
 helm_directory: chart
 release_name: bad-helm-coredns-coredns
-service_name: bad-helm-coredns-coredns
diff --git a/sample-cnfs/sample-coredns-cnf-bad-chart/cnf-testsuite.yml b/sample-cnfs/sample-coredns-cnf-bad-chart/cnf-testsuite.yml
@@ -1,6 +1,5 @@
 ---
 release_name: coredns
-service_name: coredns-coredns 
 helm_repository:
   name: stable 
   repo_url: https://cncf.gitlab.io/stable

diff --git a/sample-cnfs/sample-coredns-cnf-source/cnf-testsuite.yml b/sample-cnfs/sample-coredns-cnf-source/cnf-testsuite.yml
@@ -1,4 +1,3 @@
 ---
 release_name: coredns
-service_name: coredns-coredns 
 helm_chart: stable/coredns
diff --git a/sample-cnfs/sample-coredns-cnf/cnf-testsuite.yml b/sample-cnfs/sample-coredns-cnf/cnf-testsuite.yml
@@ -1,6 +1,5 @@
 ---
 release_name: coredns
-service_name: coredns-coredns 
 helm_repository:
   name: stable 
   repo_url: https://cncf.gitlab.io/stable

diff --git a/sample-cnfs/sample-coredns-cnf2/cnf-testsuite.yml b/sample-cnfs/sample-coredns-cnf2/cnf-testsuite.yml
@@ -1,6 +1,5 @@
 ---
 release_name: coredns2
-service_name: coredns-coredns 
 helm_repository:
   name: stable 
   repo_url: https://cncf.gitlab.io/stable

diff --git a/sample-cnfs/sample-coredns-cnf3/cnf-testsuite.yml b/sample-cnfs/sample-coredns-cnf3/cnf-testsuite.yml
@@ -1,6 +1,5 @@
 ---
 release_name: coredns3
-service_name: coredns-coredns 
 helm_repository:
   name: stable 
   repo_url: https://cncf.gitlab.io/stable

diff --git a/sample-cnfs/sample-coredns-cnf4/cnf-testsuite.yml b/sample-cnfs/sample-coredns-cnf4/cnf-testsuite.yml
@@ -1,6 +1,5 @@
 ---
 release_name: coredns4
-service_name: coredns-coredns 
 helm_repository:
   name: stable 
   repo_url: https://cncf.gitlab.io/stable

diff --git a/sample-cnfs/sample-fragile-state/cnf-testsuite.yml b/sample-cnfs/sample-fragile-state/cnf-testsuite.yml
@@ -1,5 +1,4 @@
 ---
 helm_directory: chart
 release_name: coredns
-service_name: coredns-coredns
 rolling_update_test_tag: 1.6.7
diff --git a/sample-cnfs/sample-generic-cnf/cnf-testsuite.yml b/sample-cnfs/sample-generic-cnf/cnf-testsuite.yml
@@ -1,6 +1,5 @@
 ---
 release_name: coredns-1609263557
-service_name: coredns-coredns
 helm_repository:
   name: stable
   repo_url: https://cncf.gitlab.io/stable

diff --git a/sample-cnfs/sample-large-cnf/cnf-testsuite.yml b/sample-cnfs/sample-large-cnf/cnf-testsuite.yml
@@ -1,7 +1,6 @@
 ---
 helm_directory: chart 
 release_name: coredns
-service_name: coredns-coredns 
 helm_repository:
   name: stable 
   repo_url: https://cncf.gitlab.io/stable
diff --git a/sample-cnfs/sample-local-storage/cnf-testsuite.yml b/sample-cnfs/sample-local-storage/cnf-testsuite.yml
@@ -2,4 +2,3 @@
 helm_directory: chart
 helm_values: 
 release_name: coredns
-service_name: coredns-coredns
diff --git a/sample-cnfs/sample-statefulset-cnf/cnf-testsuite.yml b/sample-cnfs/sample-statefulset-cnf/cnf-testsuite.yml
@@ -1,7 +1,6 @@
 ---
 release_name: test
 
-service_name: 
 helm_repository:
   name: bitnami 
   repo_url: https://charts.bitnami.com/bitnami 

diff --git a/sample-cnfs/sample_bad_signal_handling/cnf-testsuite.yml b/sample-cnfs/sample_bad_signal_handling/cnf-testsuite.yml
@@ -1,4 +1,3 @@
 ---
 helm_directory: chart
 release_name: envoy 
-service_name: envoy
diff --git a/sample-cnfs/sample_coredns_bad_liveness/cnf-testsuite.yml b/sample-cnfs/sample_coredns_bad_liveness/cnf-testsuite.yml
@@ -1,4 +1,3 @@
 ---
 helm_directory: chart
 release_name: bad-liveness
-service_name: bad-liveness-coredns 
diff --git a/sample-cnfs/sample_coredns_hardcoded_ips/cnf-testsuite.yml b/sample-cnfs/sample_coredns_hardcoded_ips/cnf-testsuite.yml
@@ -1,4 +1,3 @@
 ---
 helm_directory: chart
 release_name: coredns
-service_name: coredns-coredns
diff --git a/sample-cnfs/sample_coredns_protected/cnf-testsuite.yml b/sample-cnfs/sample_coredns_protected/cnf-testsuite.yml
@@ -1,4 +1,3 @@
 ---
 helm_directory: chart
 release_name: coredns --set imageCredentials.registry=https://index.docker.io/v1/ --set imageCredentials.username=$PROTECTED_DOCKERHUB_USERNAME --set imageCredentials.password=$PROTECTED_DOCKERHUB_PASSWORD --set imageCredentials.email=$PROTECTED_DOCKERHUB_EMAIL --set image.repository=$PROTECTED_IMAGE_REPO
-service_name: coredns-coredns
diff --git a/sample-cnfs/sample_envoy_slow_startup/cnf-testsuite.yml b/sample-cnfs/sample_envoy_slow_startup/cnf-testsuite.yml
@@ -1,4 +1,3 @@
 ---
 helm_directory: chart
 release_name: envoy 
-service_name: envoy
diff --git a/sample-cnfs/sample_good_signal_handling/cnf-testsuite.yml b/sample-cnfs/sample_good_signal_handling/cnf-testsuite.yml
@@ -1,4 +1,3 @@
 ---
 helm_directory: chart
 release_name: envoy 
-service_name: envoy
diff --git a/sample-cnfs/sample_good_signal_handling_tini/cnf-testsuite.yml b/sample-cnfs/sample_good_signal_handling_tini/cnf-testsuite.yml
@@ -1,6 +1,5 @@
 ---
 release_name: jenkins
-service_name: jenkins
 helm_repository:
   name: jenkins
   repo_url: https://charts.jenkins.io

diff --git a/sample-cnfs/sample_good_zombie_handling/cnf-testsuite.yml b/sample-cnfs/sample_good_zombie_handling/cnf-testsuite.yml
@@ -1,4 +1,3 @@
 ---
 helm_directory: chart
 release_name: envoy 
-service_name: envoy
diff --git a/sample-cnfs/sample_hostport/cnf-testsuite.yml b/sample-cnfs/sample_hostport/cnf-testsuite.yml
@@ -3,4 +3,3 @@ helm_directory: chart
 git_clone_url: 
 install_script: chart
 release_name: unifi
-service_name: unifi-controller 
diff --git a/sample-cnfs/sample_immutable_configmap_all/cnf-testsuite.yml b/sample-cnfs/sample_immutable_configmap_all/cnf-testsuite.yml
@@ -1,4 +1,3 @@
 ---
 helm_directory: chart
 release_name: coredns
-service_name: coredns-coredns
diff --git a/sample-cnfs/sample_immutable_configmap_all_plus_env/cnf-testsuite.yml b/sample-cnfs/sample_immutable_configmap_all_plus_env/cnf-testsuite.yml
@@ -1,4 +1,3 @@
 ---
 helm_directory: chart
 release_name: coredns
-service_name: coredns-coredns
diff --git a/sample-cnfs/sample_immutable_configmap_all_plus_env_but_fail/cnf-testsuite.yml b/sample-cnfs/sample_immutable_configmap_all_plus_env_but_fail/cnf-testsuite.yml
@@ -1,4 +1,3 @@
 ---
 helm_directory: chart
 release_name: coredns
-service_name: coredns-coredns
diff --git a/sample-cnfs/sample_immutable_configmap_some/cnf-testsuite.yml b/sample-cnfs/sample_immutable_configmap_some/cnf-testsuite.yml
@@ -1,4 +1,3 @@
 ---
 helm_directory: chart
 release_name: coredns
-service_name: coredns-coredns
diff --git a/sample-cnfs/sample_local_registry/cnf-testsuite.yml b/sample-cnfs/sample_local_registry/cnf-testsuite.yml
@@ -1,4 +1,3 @@
 ---
 helm_directory: chart
 release_name: coredns
-service_name: coredns-coredns
diff --git a/sample-cnfs/sample_local_registry_org_image/cnf-testsuite.yml b/sample-cnfs/sample_local_registry_org_image/cnf-testsuite.yml
@@ -1,4 +1,3 @@
 ---
 helm_directory: chart
 release_name: coredns
-service_name: coredns-coredns
diff --git a/sample-cnfs/sample_local_registry_rolling/cnf-testsuite.yml b/sample-cnfs/sample_local_registry_rolling/cnf-testsuite.yml
@@ -1,7 +1,6 @@
 ---
 helm_directory: chart
 release_name: coredns
-service_name: coredns-coredns
 container_names: 
   - name: coredns 
     rolling_update_test_tag: "1.8.0"

diff --git a/sample-cnfs/sample_network_loss/cnf-testsuite.yml b/sample-cnfs/sample_network_loss/cnf-testsuite.yml
@@ -1,4 +1,3 @@
 ---
 helm_directory: chart
 release_name: coredns
-service_name: coredns-coredns
diff --git a/sample-cnfs/sample_nodeport/cnf-testsuite.yml b/sample-cnfs/sample_nodeport/cnf-testsuite.yml
@@ -3,4 +3,3 @@ helm_directory: chart
 git_clone_url: 
 install_script: chart
 release_name: unifi
-service_name: unifi-controller
diff --git a/sample-cnfs/sample_privileged_cnf/cnf-testsuite.yml b/sample-cnfs/sample_privileged_cnf/cnf-testsuite.yml
@@ -1,4 +1,3 @@
 ---
 helm_directory: chart
 release_name: privileged-coredns
-service_name: privileged-coredns
diff --git a/sample-cnfs/sample_rolling_invalid_version/cnf-testsuite.yml b/sample-cnfs/sample_rolling_invalid_version/cnf-testsuite.yml
@@ -1,7 +1,6 @@
 ---
 helm_directory: chart
 release_name: coredns
-service_name: coredns-coredns
 helm_repository:
   name: stable 
   repo_url: https://cncf.gitlab.io/stable

diff --git a/sample-cnfs/sample_secret_env/cnf-testsuite.yml b/sample-cnfs/sample_secret_env/cnf-testsuite.yml
@@ -1,4 +1,3 @@
 ---
 helm_directory: postgresql
 release_name: postgresql
-service_name: postgresql
diff --git a/sample-cnfs/sample_secret_env_no_ref/cnf-testsuite.yml b/sample-cnfs/sample_secret_env_no_ref/cnf-testsuite.yml
@@ -1,4 +1,3 @@
 ---
 helm_directory: postgresql
 release_name: postgresql
-service_name: postgresql
diff --git a/sample-cnfs/sample_secret_volume/cnf-testsuite.yml b/sample-cnfs/sample_secret_volume/cnf-testsuite.yml
@@ -3,4 +3,3 @@ helm_directory: postgresql
 git_clone_url: 
 install_script: chart
 release_name: postgresql
-service_name: postgresql
diff --git a/sample-cnfs/sample_unmounted_secret_volume/cnf-testsuite.yml b/sample-cnfs/sample_unmounted_secret_volume/cnf-testsuite.yml
@@ -3,4 +3,3 @@ helm_directory: postgresql
 git_clone_url: 
 install_script: chart
 release_name: postgresql
-service_name: postgresql
diff --git a/sample-cnfs/sample_whitelisted_privileged_cnf/cnf-testsuite.yml b/sample-cnfs/sample_whitelisted_privileged_cnf/cnf-testsuite.yml
@@ -1,5 +1,4 @@
 ---
 helm_directory: chart
 release_name: privileged-coredns
-service_name: privileged-coredns-coredns 
 allowlist_helm_chart_container_names: [coredns]
diff --git a/src/tasks/setup.cr b/src/tasks/setup.cr
@@ -25,3 +25,11 @@ task "configuration_file_setup" do |_, args|
   CNFManager::Points.create_points_yml
 end
 
+task "test_config" do |_, args|
+  if args.named["cfg"]?
+    puts CNFInstall::Config.parse_cnf_config_from_file(args.named["cfg"].to_s).inspect
+  else
+    stdout_failure "cfg parameter needed"
+    exit 1
+  end
+end
diff --git a/src/tasks/utils/cnf_installation/config.cr b/src/tasks/utils/cnf_installation/config.cr
@@ -0,0 +1,32 @@
+require "yaml"
+require "../utils.cr"
+require "./config_versions/config_v2.cr"
+
+module CNFInstall
+  module Config
+
+    class Config < ConfigV2::Config
+    end
+
+    def self.parse_cnf_config_from_file(path_to_config)
+      yaml_content = File.read(path_to_config)
+      config_dir = CNFManager.ensure_cnf_testsuite_dir(path_to_config)
+      begin
+        parse_cnf_config_from_yaml(yaml_content, config_dir)
+      rescue exception
+        stdout_failure "Error during parsing CNF config on #{path_to_config}"
+        stdout_failure exception.message
+        stdout_failure "Please check your config according to the config template."
+        exit 1
+      end
+    end
+
+    def self.parse_cnf_config_from_yaml(yaml_content, config_dir)
+      config = Config.from_yaml(yaml_content)
+
+      config.dynamic.initialize_dynamic_properties(config, config_dir)
+
+      config
+    end
+  end
+end
diff --git a/src/tasks/utils/cnf_installation/config_versions/config_base.cr b/src/tasks/utils/cnf_installation/config_versions/config_base.cr
@@ -0,0 +1,8 @@
+module CNFInstall
+  module Config
+    class ConfigBase
+      include YAML::Serializable
+      include YAML::Serializable::Strict
+    end
+  end
+end