Make tests portable again (and take a step towards future flexible te…

…sting)
ThrowTheSwitch · May 20, 2024 · 4b2dbd3 · 4b2dbd3
1 parent 2aaf256
commit 4b2dbd3
Show file tree

Hide file tree

Showing 4 changed files with 76 additions and 30 deletions.
diff --git a/assets/project_with_guts_gcov.yml b/assets/project_with_guts_gcov.yml
@@ -228,7 +228,7 @@
 :gcov:
   :utilities:
     - gcovr           # Use gcovr to create the specified reports (default).
-    - ReportGenerator # Use ReportGenerator to create the specified reports.
+    #- ReportGenerator # Use ReportGenerator to create the specified reports.
   :reports: # Specify one or more reports to generate.
     # Make an HTML summary report.
     - HtmlBasic

diff --git a/spec/gcov/gcov_deployment_spec.rb b/spec/gcov/gcov_deployment_spec.rb
@@ -13,6 +13,7 @@
     include CeedlingTestCases
     include GcovTestCases
     before :all do
+      determine_reports_to_test
       @c = SystemContext.new
       @c.deploy_gem
     end

diff --git a/spec/gcov/gcov_test_cases_spec.rb b/spec/gcov/gcov_test_cases_spec.rb
@@ -14,6 +14,30 @@
 
 module GcovTestCases
 
+  def determine_reports_to_test
+    @gcov_reports = []
+
+    begin
+      `gcovr --version 2>&1`
+      @gcov_reports << :gcovr if $?.exitstatus == 0
+    rescue
+      puts "No GCOVR exec to test against"
+    end
+
+    begin
+      `reportgenerator --version 2>&1`
+      @gcov_reports << :reportgenerator if $?.exitstatus == 0
+    rescue
+      puts "No ReportGenerator exec to test against"
+    end
+  end
+
+  def prep_project_yml_for_coverage
+    FileUtils.cp test_asset_path("project_with_guts_gcov.yml"), "project.yml"
+    @c.comment_project_yml_option_for_test("- gcovr") unless @gcov_reports.include? :gcovr
+    @c.uncomment_project_yml_option_for_test("- ReportGenerator") if @gcov_reports.include? :reportgenerator
+  end
+
   def _add_gcov_section_in_project(project_file_path, name, values)
     project_file_contents = File.readlines(project_file_path)
     name_index = project_file_contents.index(":gcov:\n")
@@ -60,7 +84,7 @@ def add_gcov_option(option, value)
   def can_test_projects_with_gcov_with_success
     @c.with_context do
       Dir.chdir @proj_name do
-        FileUtils.cp test_asset_path("project_with_guts_gcov.yml"), "project.yml"
+        prep_project_yml_for_coverage
         FileUtils.cp test_asset_path("example_file.h"), 'src/'
         FileUtils.cp test_asset_path("example_file.c"), 'src/'
         FileUtils.cp test_asset_path("test_example_file_success.c"), 'test/'
@@ -78,7 +102,7 @@ def can_test_projects_with_gcov_with_success
   def can_test_projects_with_gcov_with_fail
     @c.with_context do
       Dir.chdir @proj_name do
-        FileUtils.cp test_asset_path("project_with_guts_gcov.yml"), "project.yml"
+        prep_project_yml_for_coverage
         FileUtils.cp test_asset_path("example_file.h"), 'src/'
         FileUtils.cp test_asset_path("example_file.c"), 'src/'
         FileUtils.cp test_asset_path("test_example_file.c"), 'test/'
@@ -96,7 +120,7 @@ def can_test_projects_with_gcov_with_fail
   # def can_test_projects_with_gcov_with_fail_because_of_uncovered_files
   #   @c.with_context do
   #     Dir.chdir @proj_name do
-  #       FileUtils.cp test_asset_path("project_with_guts_gcov.yml"), "project.yml"
+  #       prep_project_yml_for_coverage
   #       add_gcov_option("abort_on_uncovered", "TRUE")
   #       FileUtils.cp test_asset_path("example_file.h"), 'src/'
   #       FileUtils.cp test_asset_path("example_file.c"), 'src/'
@@ -116,7 +140,7 @@ def can_test_projects_with_gcov_with_fail
   # def can_test_projects_with_gcov_with_success_because_of_ignore_uncovered_list
   #   @c.with_context do
   #     Dir.chdir @proj_name do
-  #       FileUtils.cp test_asset_path("project_with_guts_gcov.yml"), "project.yml"
+  #       prep_project_yml_for_coverage
   #       add_gcov_option("abort_on_uncovered", "TRUE")
   #       add_gcov_section("uncovered_ignore_list", ["src/foo_file.c"])
   #       FileUtils.cp test_asset_path("example_file.h"), "src/"
@@ -138,7 +162,7 @@ def can_test_projects_with_gcov_with_fail
   # def can_test_projects_with_gcov_with_success_because_of_ignore_uncovered_list_with_globs
   #   @c.with_context do
   #     Dir.chdir @proj_name do
-  #       FileUtils.cp test_asset_path("project_with_guts_gcov.yml"), "project.yml"
+  #       prep_project_yml_for_coverage
   #       add_gcov_option("abort_on_uncovered", "TRUE")
   #       add_gcov_section("uncovered_ignore_list", ["src/B/**"])
   #       FileUtils.mkdir_p(["src/A", "src/B/C"])
@@ -162,7 +186,7 @@ def can_test_projects_with_gcov_with_fail
   def can_test_projects_with_gcov_with_compile_error
     @c.with_context do
       Dir.chdir @proj_name do
-        FileUtils.cp test_asset_path("project_with_guts_gcov.yml"), "project.yml"
+        prep_project_yml_for_coverage
         FileUtils.cp test_asset_path("example_file.h"), 'src/'
         FileUtils.cp test_asset_path("example_file.c"), 'src/'
         FileUtils.cp test_asset_path("test_example_file_boom.c"), 'test/'
@@ -177,8 +201,8 @@ def can_test_projects_with_gcov_with_compile_error
   def can_fetch_project_help_for_gcov
     @c.with_context do
       Dir.chdir @proj_name do
-        FileUtils.cp test_asset_path("project_with_guts_gcov.yml"), "project.yml"
-        output = `bundle exec ruby -S ceedling help`
+        prep_project_yml_for_coverage
+        output = `bundle exec ruby -S ceedling help 2>&1`
         expect($?.exitstatus).to match(0)
         expect(output).to match(/ceedling gcov:\*/i)
         expect(output).to match(/ceedling gcov:all/i)
@@ -189,27 +213,31 @@ def can_fetch_project_help_for_gcov
   def can_create_html_reports
     @c.with_context do
       Dir.chdir @proj_name do
-        FileUtils.cp test_asset_path("project_with_guts_gcov.yml"), "project.yml"
+        prep_project_yml_for_coverage
         FileUtils.cp test_asset_path("example_file.h"), 'src/'
         FileUtils.cp test_asset_path("example_file.c"), 'src/'
         FileUtils.cp test_asset_path("test_example_file_success.c"), 'test/'
 
-        output = `bundle exec ruby -S ceedling gcov:all`
-        expect(output).to match(/Generating HTML coverage report in 'build\/artifacts\/gcov\/gcovr'\.\.\./)
-        expect(output).to match(/Generating HtmlBasic coverage report in 'build\/artifacts\/gcov\/ReportGenerator'\.\.\./)
-        expect(File.exist?('build/artifacts/gcov/gcovr/GcovCoverageResults.html')).to eq true
-        expect(File.exist?('build/artifacts/gcov/ReportGenerator/summary.htm')).to eq true
+        output = `bundle exec ruby -S ceedling gcov:all 2>&1`
+        if @gcov_reports.include? :gcovr
+          expect(output).to match(/Generating HTML coverage report in 'build\/artifacts\/gcov\/gcovr'\.\.\./)
+          expect(File.exist?('build/artifacts/gcov/gcovr/GcovCoverageResults.html')).to eq true
+        end
+        if @gcov_reports.include? :modulegenerator
+          expect(output).to match(/Generating HtmlBasic coverage report in 'build\/artifacts\/gcov\/ReportGenerator'\.\.\./)
+          expect(File.exist?('build/artifacts/gcov/ReportGenerator/summary.htm')).to eq true
+        end
       end
     end
   end
 
   def can_create_html_reports_from_crashing_test_runner_with_enabled_debug_for_test_cases_not_causing_crash
     @c.with_context do
       Dir.chdir @proj_name do
+        prep_project_yml_for_coverage
         FileUtils.cp test_asset_path("example_file.h"), 'src/'
         FileUtils.cp test_asset_path("example_file.c"), 'src/'
         FileUtils.cp test_asset_path("test_example_file_crash.c"), 'test/'
-        FileUtils.cp test_asset_path("project_with_guts_gcov.yml"), 'project.yml'
 
         @c.merge_project_yml_for_test({:project => { :use_backtrace => :gdb }})
 
@@ -225,21 +253,25 @@ def can_create_html_reports_from_crashing_test_runner_with_enabled_debug_for_tes
         expect(output).to match(/FAILED:\s+(?:1|2)/)
         expect(output).to match(/IGNORED:\s+0/)
         expect(output).to match(/example_file.c \| Lines executed:5?0.00% of 4/)
-        expect(output).to match(/Generating HTML coverage report in 'build\/artifacts\/gcov\/gcovr'\.\.\./)
-        expect(output).to match(/Generating HtmlBasic coverage report in 'build\/artifacts\/gcov\/ReportGenerator'\.\.\./)
-        expect(File.exist?('build/artifacts/gcov/gcovr/GcovCoverageResults.html')).to eq true
-        expect(File.exist?('build/artifacts/gcov/ReportGenerator/summary.htm')).to eq true
+        if @gcov_reports.include? :gcovr
+          expect(output).to match(/Generating HTML coverage report in 'build\/artifacts\/gcov\/gcovr'\.\.\./)
+          expect(File.exist?('build/artifacts/gcov/gcovr/GcovCoverageResults.html')).to eq true
+        end
+        if @gcov_reports.include? :modulegenerator
+          expect(output).to match(/Generating HtmlBasic coverage report in 'build\/artifacts\/gcov\/ReportGenerator'\.\.\./)
+          expect(File.exist?('build/artifacts/gcov/ReportGenerator/summary.htm')).to eq true
+        end
       end
     end
   end
 
   def can_create_html_reports_from_crashing_test_runner_with_enabled_debug_with_zero_coverage
     @c.with_context do
       Dir.chdir @proj_name do
+        prep_project_yml_for_coverage
         FileUtils.cp test_asset_path("example_file.h"), 'src/'
         FileUtils.cp test_asset_path("example_file.c"), 'src/'
         FileUtils.cp test_asset_path("test_example_file_crash.c"), 'test/'
-        FileUtils.cp test_asset_path("project_with_guts_gcov.yml"), 'project.yml'
 
         @c.merge_project_yml_for_test({:project => { :use_backtrace => :gdb }})
 
@@ -256,21 +288,25 @@ def can_create_html_reports_from_crashing_test_runner_with_enabled_debug_with_ze
         expect(output).to match(/IGNORED:\s+0/)
         expect(output).to match(/example_file.c \| Lines executed:0.00% of 4/)
 
-        expect(output).to match(/Generating HTML coverage report in 'build\/artifacts\/gcov\/gcovr'\.\.\./)
-        expect(output).to match(/Generating HtmlBasic coverage report in 'build\/artifacts\/gcov\/ReportGenerator'\.\.\./)
-        expect(File.exist?('build/artifacts/gcov/gcovr/GcovCoverageResults.html')).to eq true
-        expect(File.exist?('build/artifacts/gcov/ReportGenerator/summary.htm')).to eq true
+        if @gcov_reports.include? :gcovr
+          expect(output).to match(/Generating HTML coverage report in 'build\/artifacts\/gcov\/gcovr'\.\.\./)
+          expect(File.exist?('build/artifacts/gcov/gcovr/GcovCoverageResults.html')).to eq true
+        end
+        if @gcov_reports.include? :modulegenerator
+          expect(output).to match(/Generating HtmlBasic coverage report in 'build\/artifacts\/gcov\/ReportGenerator'\.\.\./)
+          expect(File.exist?('build/artifacts/gcov/ReportGenerator/summary.htm')).to eq true
+        end
       end
     end
   end
 
   def can_create_html_reports_from_test_runner_with_enabled_debug_with_100_coverage_when_excluding_crashing_test_case
     @c.with_context do
       Dir.chdir @proj_name do
+        prep_project_yml_for_coverage
         FileUtils.cp test_asset_path("example_file.h"), 'src/'
         FileUtils.cp test_asset_path("example_file.c"), 'src/'
         FileUtils.cp test_asset_path("test_example_file_crash.c"), 'test/'
-        FileUtils.cp test_asset_path("project_with_guts_gcov.yml"), 'project.yml'
 
         add_test_case = "\nvoid test_difference_between_two_numbers(void)\n"\
                         "{\n" \
@@ -290,10 +326,14 @@ def can_create_html_reports_from_test_runner_with_enabled_debug_with_100_coverag
         expect(output).to match(/IGNORED:\s+0/)
         expect(output).to match(/example_file.c \| Lines executed:100.00% of 4/)
 
-        expect(output).to match(/Generating HTML coverage report in 'build\/artifacts\/gcov\/gcovr'\.\.\./)
-        expect(output).to match(/Generating HtmlBasic coverage report in 'build\/artifacts\/gcov\/ReportGenerator'\.\.\./)
-        expect(File.exist?('build/artifacts/gcov/gcovr/GcovCoverageResults.html')).to eq true
-        expect(File.exist?('build/artifacts/gcov/ReportGenerator/summary.htm')).to eq true
+        if @gcov_reports.include? :gcovr
+          expect(output).to match(/Generating HTML coverage report in 'build\/artifacts\/gcov\/gcovr'\.\.\./)
+          expect(File.exist?('build/artifacts/gcov/gcovr/GcovCoverageResults.html')).to eq true
+        end
+        if @gcov_reports.include? :modulegenerator
+          expect(output).to match(/Generating HtmlBasic coverage report in 'build\/artifacts\/gcov\/ReportGenerator'\.\.\./)
+          expect(File.exist?('build/artifacts/gcov/ReportGenerator/summary.htm')).to eq true
+        end
       end
     end
   end

diff --git a/spec/spec_system_helper.rb b/spec/spec_system_helper.rb
@@ -163,6 +163,11 @@ def uncomment_project_yml_option_for_test(option)
     fake_prj_yml= File.read('project.yml').gsub(/\##{option}/,option)
     File.write('project.yml', fake_prj_yml, mode: 'w')
   end
+
+  def comment_project_yml_option_for_test(option)
+    fake_prj_yml= File.read('project.yml').gsub(/#{option}/,"##{option}")
+    File.write('project.yml', fake_prj_yml, mode: 'w')
+  end
   ############################################################
 end