Fixed unit tests, verifying doubles, fixed handling of invalid XML (#2)

* Fixed unit tests, verifying doubles, fixed handling of invalid XML

* Enable RSpec verifying doubles

* Error logging

.rspec

@@ -0,0 +1 @@
+--color --format doc

package/sap-installation-wizard.changes

@@ -1,3 +1,14 @@
+-------------------------------------------------------------------
+Wed Jan 19 13:50:46 UTC 2022 - Ladislav Slezák <lslezak@suse.cz>
+
+- Unit tests:
+  - Enable RSpec verifying doubles to ensue that the mocked
+    methods really exist (bsc#1194784)
+  - Fixed to actually pass
+  - Run them during RPM build
+- Do not crash if the partitioning XML is not valid
+- 4.4.1
+
 -------------------------------------------------------------------
 Tue Jan 18 14:42:07 UTC 2022 - Ladislav Slezák <lslezak@suse.cz>
 

package/sap-installation-wizard.spec

@@ -20,7 +20,7 @@ Name:           sap-installation-wizard
 Summary:        Installation wizard for SAP applications
 License:        GPL-2.0+
 Group:          System/YaST
-Version:        4.4.0
+Version:        4.4.1
 Release:        0
 PreReq:         /bin/mkdir %insserv_prereq %fillup_prereq yast2
 BuildRequires:  yast2
@@ -67,7 +67,7 @@ Authors:
 %setup -q
 
 %check
-#rake test:unit
+rake test:unit
 
 %build
 

src/lib/y2sap/clients/create_storage.rb

@@ -103,6 +103,9 @@ def read_partitioning
 
         profile = Yast::XML.XMLToYCPFile(filename)
         profile && profile["partitioning"]
+      rescue Yast::XMLDeserializationError
+        log.error("Cannot parse XML file #{filename}")
+        nil
       end
 
       # Select a disk with to use

test/spec_helper.rb

@@ -29,6 +29,14 @@
 require "yast"
 require "yast/rspec"
 
+# configure RSpec
+RSpec.configure do |config|
+  config.mock_with :rspec do |c|
+    # https://relishapp.com/rspec/rspec-mocks/v/3-0/docs/verifying-doubles/partial-doubles
+    c.verify_partial_doubles = true
+  end
+end
+
 if ENV["COVERAGE"]
   require "simplecov"
   SimpleCov.start do
@@ -38,12 +46,20 @@
   # track all ruby files under src
   SimpleCov.track_files("#{SRC_PATH}/lib/**/*.rb")
 
-  # use coveralls for on-line code coverage reporting at Travis CI
-  if ENV["TRAVIS"]
-    require "coveralls"
+  # additionally use the LCOV format for on-line code coverage reporting at CI
+  if ENV["CI"] || ENV["COVERAGE_LCOV"]
+    require "simplecov-lcov"
+
+    SimpleCov::Formatter::LcovFormatter.config do |c|
+      c.report_with_single_file = true
+      # this is the default Coveralls GitHub Action location
+      # https://github.com/marketplace/actions/coveralls-github-action
+      c.single_report_path = "coverage/lcov.info"
+    end
+
     SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
       SimpleCov::Formatter::HTMLFormatter,
-      Coveralls::SimpleCov::Formatter
+      SimpleCov::Formatter::LcovFormatter
     ]
   end
 end

test/y2sap/clients/create_storage_test.rb

@@ -54,7 +54,7 @@
   end
   let(:issues_list) { [] }
 
-  let(:usr) { instance_double(Y2Storage::Filesystems::BlkFilesystem, mount_point: "/usr") }
+  let(:usr) { instance_double(Y2Storage::Filesystems::BlkFilesystem, mount_path: "/usr") }
   let(:filesystems) { [usr] }
 
   describe "#main" do
@@ -191,7 +191,7 @@
 
     context "when any wanted mount point already exist" do
       let(:hana_data) do
-        instance_double(Y2Storage::Filesystems::BlkFilesystem, mount_point: "/hana/data")
+        instance_double(Y2Storage::Filesystems::BlkFilesystem, mount_path: "/hana/data")
       end
       let(:filesystems) { [usr, hana_data] }
 
@@ -205,6 +205,7 @@
       end
 
       it "logs existing mount points" do
+        allow(client.log).to receive(:info).and_call_original
         expect(client.log).to receive(:info).with(/\/hana\/data/).and_call_original
         client.main
       end

test/y2sap/media_test.rb

@@ -27,10 +27,6 @@
 
 describe Y2Sap::Media do
   context "no sysconfig file exist" do
-    subject { described_class.new }
-    before do
-      change_scr_root("/")
-    end
     it "reads the default base configuration" do
       expect(subject.mount_point).to eq "/mnt"
       expect(subject.inst_mode).to   eq "manual"
@@ -47,8 +43,12 @@
   end
   context "sysconfig file does exist" do
     subject { described_class.new }
-    before do
+    around do |example|
+      # change the SCR root to a testing directory
       change_scr_root(File.join(DATA_PATH, "system"))
+      example.run
+      # restore it back
+      reset_scr_root
     end
     it "reads the base configuration from sysconfig file" do
       expect(subject.mount_point).to eq "/tmp/mnt"
@@ -62,9 +62,16 @@
     before do
       allow(Yast::SCR).to receive(:Execute).with(Yast::Path.new(".target.bash_output"), /du/)
         .and_return(out)
+    end
+
+    around do |example|
+      # change the SCR root to a testing directory
       change_scr_root(File.join(DATA_PATH, "system"))
-      subject { described_class.new }
+      example.run
+      # restore it back
+      reset_scr_root
     end
+
     it "reads the tech size of /etc" do
       expect(subject.tech_size("/etc")).to eq(200)
     end

test/y2sap/products_test.rb

@@ -33,7 +33,6 @@
   context "no sysconfig file exist" do
     let(:media) { Y2Sap::Media.new }
     before do
-      change_scr_root("/")
       subject.media.product_definitions = DATA_PATH + "/system/etc/sap-installation-wizard.xml"
     end
     it "check the initalization of global variables" do
@@ -61,9 +60,13 @@
   end
   context "sysconfig file does exist" do
     let(:media) { Y2Sap::Media.new }
-    before do
+    around do |example|
+      # change the SCR root to a testing directory
       change_scr_root(File.join(DATA_PATH, "system"))
       subject.media.product_definitions = DATA_PATH + "/system/etc/sap-installation-wizard.xml"
+      example.run
+      # restore it back
+      reset_scr_root
     end
     it "reads the base configuration from sysconfig file" do
       expect(subject.media.mount_point).to eq "/tmp/mnt"