Adjust OneLogin namespace compatibility, defining Module instead Alias to Object. Fix compatibility with Logging

Author: pitbulk

UPGRADING.md

@@ -33,8 +33,15 @@ the class names themselves have intentionally been kept the same.
 Note that the project folder structure has also been updated accordingly. Notably, the directory
 `lib/onelogin/schemas` is now `lib/ruby_saml/schemas`.
 
-For backward compatibility, the alias `OneLogin = Object` has been set, so `RubySaml::` will still work
-as before. This alias will be removed in RubySaml version `3.0.0`.
+For backward compatibility, a module is defined at lib/ruby_saml.rb, so `RubySaml::` will still work
+as before. This module will be removed in RubySaml version `3.0.0`.
+```
+unless defined?(::OneLogin)
+    module OneLogin
+        RubySaml = ::RubySaml
+    end
+end
+```
 
 
 ### Deprecation and removal of "XMLSecurity" namespace

lib/ruby_saml.rb

@@ -20,5 +20,17 @@
 require 'ruby_saml/utils'
 require 'ruby_saml/version'
 
-# @deprecated This alias adds compatibility with v1.x and will be removed in v3.0.0
-OneLogin = Object
+# @deprecated This module adds compatibility with v1.x and will be removed in v3.0.0
+unless defined?(::OneLogin)
+    module OneLogin
+        RubySaml = ::RubySaml
+    end
+end
+
+unless defined?(::OneLogin::RubySaml::Logging)
+    module OneLogin
+        module RubySaml
+            Logging = ::RubySaml::Logging
+        end
+    end
+end

test/logging_test.rb

@@ -58,5 +58,56 @@ class LoggingTest < Minitest::Test
         RubySaml::Logging.info('sup?')
       end
     end
+
+    describe "OneLogin::RubySaml::Logging compatibility" do
+      it "defines OneLogin::RubySaml::Logging as an alias to RubySaml::Logging" do
+        assert defined?(OneLogin::RubySaml::Logging),
+               "Expected OneLogin::RubySaml::Logging to be defined"
+
+        assert_equal RubySaml::Logging.object_id,
+                     OneLogin::RubySaml::Logging.object_id,
+                     "Expected OneLogin::RubySaml::Logging to alias RubySaml::Logging"
+      end
+
+      it "shares the same logger instance when set via RubySaml::Logging" do
+        logger = mock('Logger')
+        RubySaml::Logging.logger = logger
+
+        assert_same logger, OneLogin::RubySaml::Logging.logger
+      end
+
+      it "shares the same logger instance when set via OneLogin::RubySaml::Logging" do
+        logger = mock('Logger')
+        OneLogin::RubySaml::Logging.logger = logger
+
+        assert_same logger, RubySaml::Logging.logger
+      end
+
+      it "delegates to the configured logger when using the legacy constant" do
+        logger = mock('Logger')
+        OneLogin::RubySaml::Logging.logger = logger
+
+        logger.expects(:debug).with('hi mom')
+        logger.expects(:info).with('sup?')
+
+        OneLogin::RubySaml::Logging.debug('hi mom')
+        OneLogin::RubySaml::Logging.info('sup?')
+      end
+
+      it "respects ENV['ruby-saml/testing'] and does not log when set (legacy constant)" do
+        logger = mock('Logger')
+        OneLogin::RubySaml::Logging.logger = logger
+
+        ENV["ruby-saml/testing"] = "1"
+
+        # No expectations on logger; any call would cause Mocha to fail the test.
+        OneLogin::RubySaml::Logging.debug('hi mom')
+        OneLogin::RubySaml::Logging.info('sup?')
+        OneLogin::RubySaml::Logging.warn('hey')
+        OneLogin::RubySaml::Logging.error('oops')
+
+        ENV.delete("ruby-saml/testing")
+      end
+    end
   end
 end

test/onelogin_alias_test.rb test/onelogin_rubysaml_compat_test.rbtest/onelogin_alias_test.rb renamed to test/onelogin_rubysaml_compat_test.rb

@@ -2,16 +2,34 @@
 
 require_relative 'test_helper'
 
-class OneloginAliasTest < Minitest::Test
+class OneLoginRubySamlCompatTest < Minitest::Test
 
-  describe 'legacy OneLogin namespace alias' do
+  describe 'legacy OneLogin namespace compatibility' do
 
-    describe 'equality with Object' do
-      it "should be equal" do
-        assert_equal OneLogin, Object
-        assert_equal ::OneLogin, Object
-        assert_equal OneLogin::RubySaml, OneLogin::RubySaml
+    describe 'namespace equality' do
+      it "defines OneLogin::RubySaml as an alias to the RubySaml module" do
+        assert defined?(OneLogin::RubySaml), "Expected OneLogin::RubySaml to be defined"
         assert_equal ::OneLogin::RubySaml, ::RubySaml
+        assert_equal RubySaml.object_id, OneLogin::RubySaml.object_id, "Expected OneLogin::RubySaml to alias RubySaml"
+      end
+
+      it "exposes Logging under OneLogin::RubySaml::Logging as an alias to RubySaml::Logging" do
+        assert defined?(OneLogin::RubySaml::Logging), "Expected OneLogin::RubySaml::Logging to be defined"
+        assert_equal ::OneLogin::RubySaml::Logging, ::RubySaml::Logging
+        assert_equal RubySaml::Logging.object_id, OneLogin::RubySaml::Logging.object_id, "Expected OneLogin::RubySaml::Logging to alias RubySaml::Logging"
+      end
+
+      it "shares the same logger instance between RubySaml::Logging and OneLogin::RubySaml::Logging" do
+        logger = mock("Logger")
+
+        RubySaml::Logging.logger = logger
+        assert_same logger, OneLogin::RubySaml::Logging.logger
+
+        other_logger = mock("OtherLogger")
+        OneLogin::RubySaml::Logging.logger = other_logger
+        assert_same other_logger, RubySaml::Logging.logger
+      ensure
+        RubySaml::Logging.logger = ::TEST_LOGGER
       end
     end