Merge pull request #391 from cncf/refactor_sample_utils

sample_utils now CNFManager

Author: denverwilliams

spec/cnf_conformance_spec.cr

@@ -40,7 +40,7 @@ describe CnfConformance do
     (/PASSED: Replicas decreased to 1/ =~ response_s).should_not be_nil
     (/PASSED: Published Helm Chart Found/ =~ response_s).should_not be_nil
     (/Final score:/ =~ response_s).should_not be_nil
-    (all_result_test_names(final_cnf_results_yml)).should eq(["volume_hostpath_not_found", "privileged", "increase_capacity", "decrease_capacity", "ip_addresses", "liveness", "readiness", "rolling_update", "nodeport_not_used", "hardcoded_ip_addresses_in_k8s_runtime_configuration", "install_script_helm", "helm_chart_valid", "helm_chart_published","helm_deploy", "reasonable_image_size", "reasonable_startup_time", "chaos_network_loss", "chaos_cpu_hog", "chaos_container_kill"])
+    (all_result_test_names(CNFManager.final_cnf_results_yml)).should eq(["volume_hostpath_not_found", "privileged", "increase_capacity", "decrease_capacity", "ip_addresses", "liveness", "readiness", "rolling_update", "nodeport_not_used", "hardcoded_ip_addresses_in_k8s_runtime_configuration", "install_script_helm", "helm_chart_valid", "helm_chart_published","helm_deploy", "reasonable_image_size", "reasonable_startup_time", "chaos_network_loss", "chaos_cpu_hog", "chaos_container_kill"])
   end
 
   it "'scalability' should run all of the scalability tests", tags: "happy-path"  do

spec/utils/sample_utils_spec.cr renamed to spec/utils/cnf_manager_spec.cr

@@ -26,7 +26,7 @@ describe "SampleUtils" do
     $?.success?.should be_true
   end
 
-  it "'wait_for_install' should wait for a cnf to be installed", tags: "happy-path"  do
+  it "'CNFManager.wait_for_install' should wait for a cnf to be installed", tags: "happy-path"  do
     `./cnf-conformance sample_coredns_setup`
     $?.success?.should be_true
 
@@ -36,118 +36,118 @@ describe "SampleUtils" do
     LOGGING.info helm
     helm_install = `#{helm} install coredns stable/coredns`
     LOGGING.info helm_install
-    wait_for_install("coredns-coredns")
+    CNFManager.wait_for_install("coredns-coredns")
     current_replicas = `kubectl get deployments coredns-coredns -o=jsonpath='{.status.readyReplicas}'`
     (current_replicas.to_i > 0).should be_true
   end
 
-  it "'sample_setup' should set up a sample cnf", tags: "happy-path"  do
+  it "'CNFManager.sample_setup' should set up a sample cnf", tags: "happy-path"  do
     args = Sam::Args.new
-    sample_setup(config_file: "sample-cnfs/sample-generic-cnf", release_name: "coredns", deployment_name: "coredns-coredns", helm_chart: "stable/coredns", helm_directory: "helm_chart", git_clone_url: "https://github.com/coredns/coredns.git", wait_count: 0 )
+    CNFManager.sample_setup(config_file: "sample-cnfs/sample-generic-cnf", release_name: "coredns", deployment_name: "coredns-coredns", helm_chart: "stable/coredns", helm_directory: "helm_chart", git_clone_url: "https://github.com/coredns/coredns.git", wait_count: 0 )
     # check if directory exists
     (Dir.exists? "cnfs/coredns-coredns").should be_true
     (File.exists?("cnfs/coredns-coredns/cnf-conformance.yml")).should be_true
     (File.exists?("cnfs/coredns-coredns/helm_chart/Chart.yaml")).should be_true
-    sample_cleanup(config_file: "sample-cnfs/sample-generic-cnf", verbose: true)
+    CNFManager.sample_cleanup(config_file: "sample-cnfs/sample-generic-cnf", verbose: true)
     (Dir.exists? "cnfs/coredns-coredns").should be_false
   end
 
-  it "'sample_setup_args' should set up a sample cnf from a argument", tags: "happy-path"  do
+  it "'CNFManager.sample_setup_args' should set up a sample cnf from a argument", tags: "happy-path"  do
     args = Sam::Args.new
-    sample_setup_args(sample_dir: "sample-cnfs/sample-generic-cnf", args: args, verbose: true, wait_count: 0 )
+    CNFManager.sample_setup_args(sample_dir: "sample-cnfs/sample-generic-cnf", args: args, verbose: true, wait_count: 0 )
     # check if directory exists
     (Dir.exists? "cnfs/coredns-coredns").should be_true
     (File.exists?("cnfs/coredns-coredns/cnf-conformance.yml")).should be_true
     (File.exists?("cnfs/coredns-coredns/helm_chart/Chart.yaml")).should be_true
-    sample_cleanup(config_file: "sample-cnfs/sample-generic-cnf", verbose: true)
+    CNFManager.sample_cleanup(config_file: "sample-cnfs/sample-generic-cnf", verbose: true)
     (Dir.exists? "cnfs/coredns-coredns").should be_false
   end
 
-  it "'sample_setup_args' should set up a sample cnf from a config file", tags: "happy-path"  do
+  it "'CNFManager.sample_setup_args' should set up a sample cnf from a config file", tags: "happy-path"  do
     args = Sam::Args.new
-    sample_setup_args(sample_dir: "sample-cnfs/sample-generic-cnf/cnf-conformance.yml", args: args, verbose: true, wait_count: 0 )
+    CNFManager.sample_setup_args(sample_dir: "sample-cnfs/sample-generic-cnf/cnf-conformance.yml", args: args, verbose: true, wait_count: 0 )
     # check if directory exists
     (Dir.exists? "sample-cnfs/sample-generic-cnf").should be_true
     (File.exists?("cnfs/coredns-coredns/cnf-conformance.yml")).should be_true
     (File.exists?("cnfs/coredns-coredns/helm_chart/Chart.yaml")).should be_true
-    sample_cleanup(config_file: "sample-cnfs/sample-generic-cnf", verbose: true)
+    CNFManager.sample_cleanup(config_file: "sample-cnfs/sample-generic-cnf", verbose: true)
     (Dir.exists? "cnfs/coredns-coredns").should be_false
   end
 
-  it "'sample_cleanup' should clean up a sample cnf from a argument", tags: "happy-path"  do
+  it "'CNFManager.sample_cleanup' should clean up a sample cnf from a argument", tags: "happy-path"  do
     args = Sam::Args.new
-    sample_setup_args(sample_dir: "sample-cnfs/sample-generic-cnf", args: args, verbose: true, wait_count: 0 )
-    cleanup = sample_cleanup(config_file: "sample-cnfs/sample-generic-cnf", verbose: true)
+    CNFManager.sample_setup_args(sample_dir: "sample-cnfs/sample-generic-cnf", args: args, verbose: true, wait_count: 0 )
+    cleanup = CNFManager.sample_cleanup(config_file: "sample-cnfs/sample-generic-cnf", verbose: true)
     (cleanup).should be_true 
     (Dir.exists? "cnfs/coredns-coredns").should be_false
     (File.exists?("cnfs/coredns-coredns/cnf-conformance.yml")).should be_false
     (File.exists?("cnfs/coredns-coredns/helm_chart/Chart.yaml")).should be_false
   end
 
-  it "'sample_setup_args' should be able to deploy using a helm_directory", tags: "happy-path"  do
+  it "'CNFManager.sample_setup_args' should be able to deploy using a helm_directory", tags: "happy-path"  do
     args = Sam::Args.new
-    sample_setup_args(sample_dir: "sample-cnfs/sample_privileged_cnf", deploy_with_chart: false, args: args, verbose: true, wait_count: 0 )
+    CNFManager.sample_setup_args(sample_dir: "sample-cnfs/sample_privileged_cnf", deploy_with_chart: false, args: args, verbose: true, wait_count: 0 )
     (Dir.exists? "cnfs/privileged-coredns-coredns").should be_true
     # should not clone
     (Dir.exists? "cnfs/privileged-coredns-coredns/privileged-coredns").should be_false
     (File.exists? "cnfs/privileged-coredns-coredns/cnf-conformance.yml").should be_true
     (File.exists? "cnfs/privileged-coredns-coredns/chart/Chart.yaml").should be_true
-    sample_cleanup(config_file: "sample-cnfs/sample_privileged_cnf", verbose: true)
+    CNFManager.sample_cleanup(config_file: "sample-cnfs/sample_privileged_cnf", verbose: true)
     (Dir.exists? "cnfs/privileged-coredns-coredns").should be_false
   end
 
   it "'cnf_destination_dir' should return the full path of the potential destination cnf directory based on the deployment name", tags: "WIP" do
     args = Sam::Args.new
-    cnf_destination_dir("spec/fixtures/cnf-conformance.yml").should contain("/cnfs/coredns-coredns")
+    CNFManager.cnf_destination_dir("spec/fixtures/cnf-conformance.yml").should contain("/cnfs/coredns-coredns")
   end
 
-  it "'cnf_config_list' should return a list of all of the config files from the cnf directory", tags: "happy-path"  do
+  it "'CNFManager.cnf_config_list' should return a list of all of the config files from the cnf directory", tags: "happy-path"  do
     args = Sam::Args.new
-    sample_setup_args(sample_dir: "sample-cnfs/sample-generic-cnf", args: args, verbose: true, wait_count: 1 )
-    sample_setup_args(sample_dir: "sample-cnfs/sample_privileged_cnf", args: args, verbose: true )
-    cnf_config_list()[0].should contain("coredns-coredns/#{CONFIG_FILE}")
+    CNFManager.sample_setup_args(sample_dir: "sample-cnfs/sample-generic-cnf", args: args, verbose: true, wait_count: 1 )
+    CNFManager.sample_setup_args(sample_dir: "sample-cnfs/sample_privileged_cnf", args: args, verbose: true )
+    CNFManager.cnf_config_list()[0].should contain("coredns-coredns/#{CONFIG_FILE}")
   end
 
-  it "'helm_repo_add' should add a helm repo if the helm repo is valid", tags: "happy-path"  do
+  it "'CNFManager.helm_repo_add' should add a helm repo if the helm repo is valid", tags: "happy-path"  do
     args = Sam::Args.new
-    sample_setup_args(sample_dir: "sample-cnfs/sample-generic-cnf", args: args, verbose: true, wait_count: 1 )
-    # helm_repo_add.should eq(true)
+    CNFManager.sample_setup_args(sample_dir: "sample-cnfs/sample-generic-cnf", args: args, verbose: true, wait_count: 1 )
+    # CNFManager.helm_repo_add.should eq(true)
     args = Sam::Args.new(["cnf-config=./sample-cnfs/sample-generic-cnf/cnf-conformance.yml"])
-    helm_repo_add(args: args).should eq(true)
+    CNFManager.helm_repo_add(args: args).should eq(true)
   end
 
-  it "'helm_repo_add' should return false if the helm repo is invalid", tags: "happy-path"  do
-    helm_repo_add("invalid", "invalid").should eq(false)
+  it "'CNFManager.helm_repo_add' should return false if the helm repo is invalid", tags: "happy-path"  do
+    CNFManager.helm_repo_add("invalid", "invalid").should eq(false)
   end
 
-  it "'validate_cnf_conformance_yml' (function) should pass, when a cnf has a valid config file yml", tags: ["unhappy-path", "validate_config"]  do
+  it "'CNFManager.validate_cnf_conformance_yml' (function) should pass, when a cnf has a valid config file yml", tags: ["unhappy-path", "validate_config"]  do
     args = Sam::Args.new(["cnf-config=sample-cnfs/sample-coredns-cnf/cnf-conformance.yml"])
 
-    yml = parsed_config_file(ensure_cnf_conformance_yml_path(args.named["cnf-config"].as(String)))
+    yml = CNFManager.parsed_config_file(CNFManager.ensure_cnf_conformance_yml_path(args.named["cnf-config"].as(String)))
     LOGGING.info yml.inspect
     ("#{yml.get("release_name").as_s?}").should eq("coredns")
 
-    valid, command_output = validate_cnf_conformance_yml(yml)
+    valid, command_output = CNFManager.validate_cnf_conformance_yml(yml)
 
     (valid).should eq(true)
     (command_output).should eq (nil)
   end
 
-  it "'validate_cnf_conformance_yml' (command) should pass, when a cnf has a valid config file yml", tags: ["unhappy-path", "validate_config"]  do
+  it "'CNFManager.validate_cnf_conformance_yml' (command) should pass, when a cnf has a valid config file yml", tags: ["unhappy-path", "validate_config"]  do
     response_s = `./cnf-conformance validate_config cnf-config=sample-cnfs/sample-coredns-cnf/cnf-conformance.yml`
     $?.success?.should be_true
     (/PASSED: CNF configuration validated/ =~ response_s).should_not be_nil
   end
 
 
-  it "'validate_cnf_conformance_yml' (function) should warn, but be valid when a cnf config file yml has fields that are not a part of the validation type", tags: ["unhappy-path", "validate_config"]  do
+  it "'CNFManager.validate_cnf_conformance_yml' (function) should warn, but be valid when a cnf config file yml has fields that are not a part of the validation type", tags: ["unhappy-path", "validate_config"]  do
     args = Sam::Args.new(["cnf-config=./spec/fixtures/cnf-conformance-unmapped-keys-and-subkeys.yml"])
 
-    yml = parsed_config_file(ensure_cnf_conformance_yml_path(args.named["cnf-config"].as(String)))
+    yml = CNFManager.parsed_config_file(CNFManager.ensure_cnf_conformance_yml_path(args.named["cnf-config"].as(String)))
     LOGGING.info yml.inspect
     ("#{yml.get("release_name").as_s?}").should eq("coredns")
 
-    status, warning_output = validate_cnf_conformance_yml(yml)
+    status, warning_output = CNFManager.validate_cnf_conformance_yml(yml)
 
     LOGGING.warn "WARNING: #{warning_output}"
 
@@ -156,7 +156,7 @@ describe "SampleUtils" do
   end
 
 
-  it "'validate_cnf_conformance_yml' (command) should warn, but be valid when a cnf config file yml has fields that are not a part of the validation type", tags: ["unhappy-path", "validate_config"]  do
+  it "'CNFManager.validate_cnf_conformance_yml' (command) should warn, but be valid when a cnf config file yml has fields that are not a part of the validation type", tags: ["unhappy-path", "validate_config"]  do
     response_s = `./cnf-conformance validate_config cnf-config=spec/fixtures/cnf-conformance-unmapped-keys-and-subkeys.yml`
     $?.success?.should be_true
     (/WARNING: Unmapped cnf_conformance.yml keys. Please add them to the validator/ =~ response_s).should_not be_nil
@@ -165,28 +165,28 @@ describe "SampleUtils" do
   end
 
 
-  it "'validate_cnf_conformance_yml' (function) should fail when an invalid cnf config file yml is used", tags: ["unhappy-path", "validate_config"]  do
+  it "'CNFManager.validate_cnf_conformance_yml' (function) should fail when an invalid cnf config file yml is used", tags: ["unhappy-path", "validate_config"]  do
     args = Sam::Args.new(["cnf-config=spec/fixtures/cnf-conformance-invalid-and-unmapped-keys.yml"])
 
-    yml = parsed_config_file(ensure_cnf_conformance_yml_path(args.named["cnf-config"].as(String)))
+    yml = CNFManager.parsed_config_file(CNFManager.ensure_cnf_conformance_yml_path(args.named["cnf-config"].as(String)))
     LOGGING.info yml.inspect
     ("#{yml.get("release_name").as_s?}").should eq("coredns")
 
-    status, warning_output = validate_cnf_conformance_yml(yml)
+    status, warning_output = CNFManager.validate_cnf_conformance_yml(yml)
 
     (status).should eq(false)
     (warning_output).should eq(nil)
   end
 
-  it "'validate_cnf_conformance_yml' (command) should fail when an invalid cnf config file yml is used", tags: ["unhappy-path", "validate_config"]  do
+  it "'CNFManager.validate_cnf_conformance_yml' (command) should fail when an invalid cnf config file yml is used", tags: ["unhappy-path", "validate_config"]  do
     response_s = `./cnf-conformance validate_config cnf-config=spec/fixtures/cnf-conformance-invalid-and-unmapped-keys.yml`
     $?.success?.should be_true
 
     (/ERROR: cnf_conformance.yml field validation error/ =~ response_s).should_not be_nil
     (/FAILURE: Critical Error with CNF Configuration. Please review USAGE.md for steps to set up a valid CNF configuration file/ =~ response_s).should_not be_nil
   end
 
-  it "'validate_cnf_conformance_yml' (command) should pass, for all sample-cnfs", tags: ["unhappy-path", "validate_config"]  do
+  it "'CNFManager.validate_cnf_conformance_yml' (command) should pass, for all sample-cnfs", tags: ["unhappy-path", "validate_config"]  do
 
     get_dirs = Dir.entries("sample-cnfs")
     dir_list = get_dirs - [".", ".."]
@@ -200,7 +200,7 @@ describe "SampleUtils" do
     end
   end
 
-  it "'validate_cnf_conformance_yml' (command) should pass, for all example-cnfs", tags: ["unhappy-path", "validate_config"]  do
+  it "'CNFManager.validate_cnf_conformance_yml' (command) should pass, for all example-cnfs", tags: ["unhappy-path", "validate_config"]  do
 
     get_dirs = Dir.entries("example-cnfs")
     dir_list = get_dirs - [".", ".."]