omnibus 3.2.2 → 4.0.0.beta.1

data/spec/functional/templating_spec.rb

@@ -0,0 +1,73 @@
+require 'spec_helper'
+
+module Omnibus
+  class RandomClass
+    include Templating
+  end
+
+  describe Templating do
+    subject { RandomClass.new }
+
+    describe '#render_template' do
+      let(:source)      { "#{tmp_path}/source.erb" }
+      let(:destination) { "#{tmp_path}/final" }
+      let(:mode)        { 0644 }
+      let(:variables)   { { name: 'Name' } }
+      let(:contents) do
+        <<-EOH.gsub(/^ {10}/, '')
+          <%= name %>
+
+          <% if false -%>
+            This is magic!
+          <% end -%>
+        EOH
+      end
+
+      let(:options) do
+        {
+          destination: destination,
+          variables:   variables,
+          mode:        mode,
+        }
+      end
+
+      before do
+        File.open(source, 'w') { |f| f.write(contents) }
+      end
+
+      context 'when no destination is given' do
+        let(:destination) { nil }
+
+        it 'renders adjacent, without the erb extension' do
+          subject.render_template(source, options)
+          expect("#{tmp_path}/source").to be_a_file
+        end
+      end
+
+      context 'when a destination is given' do
+
+        it 'renders at the destination' do
+          subject.render_template(source, options)
+          expect(destination).to be_a_file
+        end
+      end
+
+      context 'when a mode is given' do
+        let(:mode) { 0755 }
+
+        it 'renders the object with the mode' do
+          subject.render_template(source, options)
+          expect(destination).to be_an_executable
+        end
+      end
+
+      context 'when an undefined variable is used' do
+        let(:contents) { "<%= not_a_real_variable %>" }
+
+        it 'raise an exception' do
+          expect { subject.render_template(source, options) }.to raise_error
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,95 +1,9 @@
 require 'rspec'
 require 'rspec/its'
 
-require 'omnibus'
-require 'fauxhai'
-
-module Omnibus
-  module RSpec
-    SPEC_DATA = File.expand_path(File.join(File.dirname(__FILE__), 'data'))
-
-    def software_path(name)
-      File.join(SPEC_DATA, 'software', "#{name}.rb")
-    end
-
-    def overrides_path(name)
-      File.join(SPEC_DATA, 'overrides', "#{name}.overrides")
-    end
-
-    def project_path(name)
-      File.join(SPEC_DATA, 'projects', "#{name}.rb")
-    end
-
-    def complicated_path
-      File.join(SPEC_DATA, 'complicated')
-    end
-
-    def fixtures_path
-      File.expand_path('../fixtures', __FILE__)
-    end
-
-    def tmp_path
-      File.expand_path('../../tmp', __FILE__)
-    end
-
-    #
-    # Stub the given environment key.
-    #
-    # @param [String] key
-    # @param [String] value
-    #
-    def stub_env(key, value)
-      unless @__env_already_stubbed__
-        allow(ENV).to receive(:[]).and_call_original
-        @__env_already_stubbed__ = true
-      end
-
-      allow(ENV).to receive(:[]).with(key).and_return(value.to_s)
-    end
-
-    #
-    # Stub Ohai with the given data.
-    #
-    # @param [Hash] data
-    #
-    def stub_ohai(options = {}, &block)
-      require 'ohai' unless defined?(Mash)
-
-      ohai = Mash.from_hash(Fauxhai.mock(options, &block).data)
-      allow(Ohai).to receive(:ohai).and_return(ohai)
-    end
-
-    #
-    # Grab the result of the log command. Since Omnibus uses the block form of
-    # the logger, this method handles both types of logging.
-    #
-    # @example
-    #   output = capture_logging { some_command }
-    #   expect(output).to include('whatever')
-    #
-    def capture_logging
-      original = Omnibus.logger
-      Omnibus.logger = TestLogger.new
-      yield
-      Omnibus.logger.output
-    ensure
-      Omnibus.logger = original
-    end
-  end
-end
-
-module Omnibus
-  class TestLogger < Logger
-    def initialize(*)
-      super(StringIO.new)
-      @level = -1
-    end
+require 'cleanroom/rspec'
 
-    def output
-      @logdev.dev.string
-    end
-  end
-end
+require 'omnibus'
 
 def windows?
   !!(RUBY_PLATFORM =~ /mswin|mingw|windows/)
@@ -100,16 +14,40 @@ def mac?
 end
 
 RSpec.configure do |config|
-  config.include Omnibus::RSpec
-  config.filter_run focus: true
+  # Custom matchers and shared examples
+  require_relative 'support/examples'
+  require_relative 'support/matchers'
+
+  require_relative 'support/env_helpers'
+  config.include(Omnibus::RSpec::EnvHelpers)
+
+  require_relative 'support/file_helpers'
+  config.include(Omnibus::RSpec::FileHelpers)
+
+  require_relative 'support/git_helpers'
+  config.include(Omnibus::RSpec::GitHelpers)
+
+  require_relative 'support/logging_helpers'
+  config.include(Omnibus::RSpec::LoggingHelpers)
+
+  require_relative 'support/ohai_helpers'
+  config.include(Omnibus::RSpec::OhaiHelpers)
+
+  require_relative 'support/path_helpers'
+  config.include(Omnibus::RSpec::PathHelpers)
+
+  require_relative 'support/shell_helpers'
+  config.include(Omnibus::RSpec::ShellHelpers)
+
+  config.filter_run(focus: true)
   config.run_all_when_everything_filtered = true
 
-  config.filter_run_excluding windows_only: true unless windows?
-  config.filter_run_excluding mac_only: true unless mac?
+  config.filter_run_excluding(windows_only: true) unless windows?
+  config.filter_run_excluding(mac_only: true) unless mac?
 
   config.before(:each) do
     # Suppress logging
-    Omnibus.logger.level = :unknown
+    Omnibus.logger.level = :nothing
 
     # Reset config
     Omnibus.reset!
@@ -123,7 +61,6 @@ RSpec.configure do |config|
   end
 
   config.after(:each) do
-    # Reset config
     Omnibus.reset!
   end
 

data/spec/support/env_helpers.rb

@@ -0,0 +1,20 @@
+module Omnibus
+  module RSpec
+    module EnvHelpers
+      #
+      # Stub the given environment key.
+      #
+      # @param [String] key
+      # @param [String] value
+      #
+      def stub_env(key, value)
+        unless @__env_already_stubbed__
+          allow(ENV).to receive(:[]).and_call_original
+          @__env_already_stubbed__ = true
+        end
+
+        allow(ENV).to receive(:[]).with(key).and_return(value.to_s)
+      end
+    end
+  end
+end

data/spec/support/examples.rb

@@ -0,0 +1,56 @@
+RSpec.shared_examples 'a software' do |name = 'chefdk'|
+  let(:project_root) { File.join(tmp_path, 'software') }
+
+  let(:name)    { name }
+  let(:source)  { nil }
+  let(:version) { '1.0.0' }
+
+  let(:build_dir)   { File.join(project_root, 'local', 'build') }
+  let(:cache_dir)   { File.join(project_root, 'local', 'cache') }
+  let(:source_dir)  { File.join(project_root, 'local', 'source') }
+  let(:project_dir) { File.join(source_dir, 'project_dir') }
+
+  let(:patches_dir)   { File.join(project_root, 'config', 'patches', name) }
+  let(:scripts_dir)   { File.join(project_root, 'config', 'scripts', name) }
+  let(:softwares_dir) { File.join(project_root, 'config', 'software', name) }
+  let(:templates_dir) { File.join(project_root, 'config', 'templates', name) }
+
+  let(:install_dir) { File.join(project_root, 'opt', name) }
+  let(:bin_dir)     { File.join(install_dir, 'embedded', 'bin') }
+
+  let(:software) do
+    double(Omnibus::Software,
+      name:        name,
+      version:     version,
+      build_dir:   build_dir,
+      install_dir: install_dir,
+      project_dir: project_dir,
+      source:      source,
+      overridden?: false,
+    )
+  end
+
+  before do
+    Omnibus::Config.cache_dir(cache_dir)
+    Omnibus::Config.source_dir(source_dir)
+
+    Omnibus::Config.project_root(project_root)
+    Omnibus::Config.build_retries(0)
+    Omnibus::Config.use_git_caching(false)
+    Omnibus::Config.software_gems(nil)
+
+    # Make the directories
+    FileUtils.mkdir_p(build_dir)
+    FileUtils.mkdir_p(cache_dir)
+    FileUtils.mkdir_p(project_dir)
+    FileUtils.mkdir_p(source_dir)
+
+    FileUtils.mkdir_p(patches_dir)
+    FileUtils.mkdir_p(scripts_dir)
+    FileUtils.mkdir_p(softwares_dir)
+    FileUtils.mkdir_p(templates_dir)
+
+    FileUtils.mkdir_p(install_dir)
+    FileUtils.mkdir_p(bin_dir)
+  end
+end

data/spec/support/file_helpers.rb

@@ -0,0 +1,46 @@
+module Omnibus
+  module RSpec
+    module FileHelpers
+      def create_directory(*paths)
+        path = File.join(*paths)
+        FileUtils.mkdir_p(path)
+        path
+      end
+
+      def remove_directory(*paths)
+        path = File.join(*paths)
+        FileUtils.rm_rf(path)
+        path
+      end
+
+      def copy_file(source, destination)
+        FileUtils.cp(source, destination)
+        destination
+      end
+
+      def remove_file(*paths)
+        path = File.join(*paths)
+        FileUtils.rm_f(path)
+        path
+      end
+
+      def create_file(*paths, &block)
+        path = File.join(*paths)
+
+        FileUtils.mkdir_p(File.dirname(path))
+
+        if block
+          File.open(path, 'wb') { |f| f.write(block.call) }
+        else
+          FileUtils.touch(path)
+        end
+
+        path
+      end
+
+      def create_link(a, b)
+        FileUtils.ln_s(a, b)
+      end
+    end
+  end
+end

data/spec/support/git_helpers.rb

@@ -0,0 +1,107 @@
+require_relative 'shell_helpers'
+
+module Omnibus
+  module RSpec
+    module GitHelpers
+      include ShellHelpers
+
+      def git_origin_for(repo, options = {})
+        "file://#{fake_git_remote("git://github.com/omnibus/#{repo}.git", options)}/.git"
+      end
+
+      def remote_git_repo(name, options = {})
+        path = File.join(remotes, name)
+        remote_url = "file://#{path}"
+
+        # Create a bogus software
+        FileUtils.mkdir_p(path)
+
+        Dir.chdir(path) do
+          git %|init --bare|
+          git %|config core.sharedrepository 1|
+          git %|config receive.denyNonFastforwards true|
+          git %|config receive.denyCurrentBranch ignore|
+        end
+
+        Dir.chdir(git_scratch) do
+          # Create a bogus configure file
+          File.open('configure', 'w') { |f| f.write('echo "Done!"') }
+
+          git %|init .|
+          git %|add .|
+          git %|commit -am "Initial commit for #{name}..."|
+          git %|remote add origin "#{remote_url}"|
+          git %|push origin master|
+
+          options[:tags].each do |tag|
+            File.open('tag', 'w') { |f| f.write(tag) }
+            git %|add tag|
+            git %|commit -am "Create tag #{tag}"|
+            git %|tag "#{tag}"|
+            git %|push origin "#{tag}"|
+          end if options[:tags]
+
+          options[:branches].each do |branch|
+            git %|checkout -b #{branch} master|
+            File.open('branch', 'w') { |f| f.write(branch) }
+            git %|add branch|
+            git %|commit -am "Create branch #{branch}"|
+            git %|push origin "#{branch}"|
+            git %|checkout master|
+          end if options[:branches]
+        end
+
+        path
+      end
+
+      # Calculate the git sha for the given ref.
+      #
+      # @param [#to_s] repo
+      #   the repository to show the ref for
+      # @param [#to_s] ref
+      #   the ref to show
+      #
+      # @return [String]
+      def sha_for_ref(repo, ref)
+        Dir.chdir(File.join(remotes, repo)) do
+          git("show-ref #{ref}").stdout.split(/\s/).first
+        end
+      end
+
+      private
+
+      # The path to store the git remotes.
+      #
+      # @return [Pathname]
+      def remotes
+        path = File.join(tmp_path, 'git', 'remotes')
+        FileUtils.mkdir_p(path) unless File.directory?(path)
+        path
+      end
+
+      def git_scratch
+        path = File.join(tmp_path, 'git', 'scratch')
+        FileUtils.mkdir_p(path) unless File.directory?(path)
+        path
+      end
+
+      def git(command)
+        #
+        # We need to override some of the variable's git uses for generating
+        # the SHASUM for testing purposes
+        #
+        time = Time.at(680227200).utc.strftime('%c %z')
+        env  = {
+          'GIT_AUTHOR_NAME'     => 'omnibus',
+          'GIT_AUTHOR_EMAIL'    => 'omnibus@getchef.com',
+          'GIT_AUTHOR_DATE'     => time,
+          'GIT_COMMITTER_NAME'  => 'omnibus',
+          'GIT_COMMITTER_EMAIL' => 'omnibus@gechef.com',
+          'GIT_COMMITTER_DATE'  => time,
+        }
+
+        shellout!("git #{command}", env: env)
+      end
+    end
+  end
+end