Spec coverage for --preserve-environments and related

Author: Kevin Paulisse

lib/octocatalog-diff/catalog-util/builddir.rb

@@ -48,21 +48,7 @@ def initialize(options = {}, logger = nil)
         @facts_terminus = options.fetch(:facts_terminus, 'yaml')
 
         create_structure
-
-        if options[:preserve_environments]
-          install_directory_symlink(logger, File.join(options[:basedir], 'environments'), 'environments')
-          options.fetch(:create_symlinks, %w(modules manifests)).each do |x|
-            install_directory_symlink(logger, File.join(options[:basedir], x), x)
-          end
-        else
-          if options[:environment]
-            logger.warn '--environment is ignored unless --preserve-environment is used' unless logger.nil?
-          end
-          if options[:create_symlinks]
-            logger.warn '--create-symlinks is ignored unless --preserve-environment is used' unless logger.nil?
-          end
-          install_directory_symlink(logger, options[:basedir])
-        end
+        create_symlinks(logger)
 
         # These configurations are optional. Don't call the methods if parameters are nil.
         unless options[:puppetdb_url].nil?
@@ -84,6 +70,30 @@ def create_structure
         end
       end
 
+      # Create symlinks.
+      #
+      # If the `--preserve-environments` option is used, the `environments` directory, plus `modules` and
+      # `manifests` symlinks are created. Otherwise, `environments/production` is pointed at the base
+      # directory.
+      #
+      # @param logger [Logger] Logger object
+      def create_symlinks(logger = nil)
+        if @options[:preserve_environments]
+          install_directory_symlink(logger, File.join(@options[:basedir], 'environments'), 'environments')
+          @options.fetch(:create_symlinks, %w(modules manifests)).each do |x|
+            install_directory_symlink(logger, File.join(@options[:basedir], x), x)
+          end
+        else
+          if @options[:environment]
+            logger.warn '--environment is ignored unless --preserve-environments is used' unless logger.nil?
+          end
+          if @options[:create_symlinks]
+            logger.warn '--create-symlinks is ignored unless --preserve-environments is used' unless logger.nil?
+          end
+          install_directory_symlink(logger, @options[:basedir])
+        end
+      end
+
       # Install puppetdb.conf file in temporary directory
       # @param server_urls [String] String for server_urls in puppetdb.conf
       # @param server_url_timeout [Fixnum] Value for server_url_timeout in puppetdb.conf

spec/octocatalog-diff/tests/catalog-util/builddir_spec.rb

@@ -25,6 +25,156 @@
     end
   end
 
+  describe '#create_symlinks' do
+    before(:each) do
+      @described_object = described_class.allocate
+    end
+
+    context 'with --preserve-environmentss' do
+      context 'with --create-symlinks' do
+        it 'should install environment + custom symlinks' do
+          @described_object.instance_variable_set(
+            '@options',
+            basedir: '/tmp/basedir',
+            preserve_environments: true,
+            create_symlinks: %w(foo bar)
+          )
+
+          expect(@described_object)
+            .to receive(:install_directory_symlink)
+            .with(nil, '/tmp/basedir/environments', 'environments')
+
+          expect(@described_object)
+            .to receive(:install_directory_symlink)
+            .with(nil, '/tmp/basedir/foo', 'foo')
+
+          expect(@described_object)
+            .to receive(:install_directory_symlink)
+            .with(nil, '/tmp/basedir/bar', 'bar')
+
+          expect { @described_object.send(:create_symlinks) }.not_to raise_error
+        end
+      end
+
+      context 'without --create-symlinks' do
+        it 'should install environment + default symlinks' do
+          @described_object.instance_variable_set(
+            '@options',
+            basedir: '/tmp/basedir',
+            preserve_environments: true
+          )
+
+          expect(@described_object)
+            .to receive(:install_directory_symlink)
+            .with(nil, '/tmp/basedir/environments', 'environments')
+
+          expect(@described_object)
+            .to receive(:install_directory_symlink)
+            .with(nil, '/tmp/basedir/manifests', 'manifests')
+
+          expect(@described_object)
+            .to receive(:install_directory_symlink)
+            .with(nil, '/tmp/basedir/modules', 'modules')
+
+          expect { @described_object.send(:create_symlinks) }.not_to raise_error
+        end
+      end
+    end
+
+    context 'without --preserve-environmentss' do
+      context 'with --create-symlinks' do
+        context 'with logger' do
+          it 'should log a warning message and install default symlink' do
+            logger = double('Logger')
+            expect(logger).to receive(:warn).with('--create-symlinks is ignored unless --preserve-environments is used')
+
+            @described_object.instance_variable_set(
+              '@options',
+              basedir: '/tmp/basedir',
+              create_symlinks: %w(foo bar)
+            )
+
+            expect(@described_object)
+              .to receive(:install_directory_symlink)
+              .with(logger, '/tmp/basedir')
+
+            expect { @described_object.send(:create_symlinks, logger) }.not_to raise_error
+          end
+        end
+
+        context 'without logger' do
+          it 'should install directory symlink' do
+            @described_object.instance_variable_set(
+              '@options',
+              basedir: '/tmp/basedir',
+              create_symlinks: %w(foo bar)
+            )
+
+            expect(@described_object)
+              .to receive(:install_directory_symlink)
+              .with(nil, '/tmp/basedir')
+
+            expect { @described_object.send(:create_symlinks) }.not_to raise_error
+          end
+        end
+      end
+
+      context 'with --environment' do
+        context 'with logger' do
+          it 'should log a warning message and install default symlink' do
+            logger = double('Logger')
+            expect(logger).to receive(:warn).with('--environment is ignored unless --preserve-environments is used')
+
+            @described_object.instance_variable_set(
+              '@options',
+              basedir: '/tmp/basedir',
+              environment: 'baz'
+            )
+
+            expect(@described_object)
+              .to receive(:install_directory_symlink)
+              .with(logger, '/tmp/basedir')
+
+            expect { @described_object.send(:create_symlinks, logger) }.not_to raise_error
+          end
+        end
+
+        context 'without logger' do
+          it 'should install default symlink' do
+            @described_object.instance_variable_set(
+              '@options',
+              basedir: '/tmp/basedir',
+              environment: 'baz'
+            )
+
+            expect(@described_object)
+              .to receive(:install_directory_symlink)
+              .with(nil, '/tmp/basedir')
+
+            expect { @described_object.send(:create_symlinks) }.not_to raise_error
+          end
+        end
+      end
+
+      context 'without --create-symlinks or --environment' do
+        it 'should install directory symlink' do
+          logger = double('Logger')
+
+          @described_object.instance_variable_set(
+            '@options',
+            basedir: '/tmp/basedir'
+          )
+
+          expect(@described_object)
+            .to receive(:install_directory_symlink)
+            .with(logger, '/tmp/basedir')
+
+          expect { @described_object.send(:create_symlinks, logger) }.not_to raise_error
+        end
+      end
+    end
+  end
+
   describe '#install_directory_symlink' do
     it 'should create properly pointed symlink' do
       options = {