Merge branch 'DP-1100-git-commit-log' into 'master'

DP-1100 : Add GIT_COMMIT env as a comment to the XML output file

Closes DP-1100

See merge request lap/alma-user-load!43

Author: steve-sullivan

lib/alma/xml_writer.rb

@@ -40,7 +40,10 @@ def ensure_open!
     end
 
     def prolog_and_opening_tag
-      "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<users>\n"
+      tag = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
+      tag += "<!-- GIT_COMMIT:#{ENV['GIT_COMMIT']} -->\n"
+      tag += "<users>\n"
+      tag
     end
 
     def ensure_io(file)

spec/data/sis/expected_xml_3.xml

@@ -1,4 +1,5 @@
 <?xml version="1.0" encoding="UTF-8"?>
+<!-- GIT_COMMIT:LOCAL_TESTING -->
 <users>
 <user>
   <record_type>PUBLIC</record_type>

spec/data/ucpath/expected_xml_1.xml

@@ -1,4 +1,5 @@
 <?xml version="1.0" encoding="UTF-8"?>
+<!-- GIT_COMMIT:LOCAL_TESTING -->
 <users>
 <user>
   <record_type>PUBLIC</record_type>

spec/lib/alma_spec.rb

@@ -37,7 +37,7 @@
       Alma::XMLWriter.open(out) { |w| w.write(@student_rec) }
       actual = File.read(out)
       xml = Alma::XMLBuilder.new(@student_rec).build
-      expected = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<users>\n#{xml}\n</users>"
+      expected = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<!-- GIT_COMMIT:LOCAL_TESTING -->\n<users>\n#{xml}\n</users>"
       expect(actual).to eq(expected)
     end
   end
@@ -51,7 +51,7 @@
       actual = File.read(out)
 
       xml = Alma::XMLBuilder.new(@student_rec).build
-      expected = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<users>\n#{xml}\n</users>"
+      expected = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<!-- GIT_COMMIT:LOCAL_TESTING -->\n<users>\n#{xml}\n</users>"
 
       expect(actual).to eq(expected)
     end

spec/spec_helper.rb

@@ -36,6 +36,11 @@
 #
 # See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
 RSpec.configure do |config|
+  # Mock ENVs for testing
+  config.before(:each) do
+    ENV['GIT_COMMIT'] = 'LOCAL_TESTING'
+  end
+
   config.color = true
   config.tty = true
   config.formatter = :documentation