yes_ship_it 0.0.5 → 0.0.6

data/lib/yes_ship_it/engine.rb

@@ -1,15 +1,28 @@
 module YSI
   class Engine
     attr_reader :assertions
+    attr_reader :executor
     attr_accessor :version, :tag_date, :release_archive
     attr_accessor :out
-    attr_accessor :dry_run
     attr_accessor :data_dir
 
     def initialize
       @assertions = []
       @out = STDOUT
       @data_dir = File.expand_path("~/.ysi")
+      self.dry_run = false
+    end
+
+    def dry_run=(dry_run)
+      if dry_run
+        @executor = DryExecutor.new
+      else
+        @executor = Executor.new
+      end
+    end
+
+    def dry_run?
+      @executor.is_a?(DryExecutor)
     end
 
     def read_config(yaml)
@@ -61,7 +74,7 @@ module YSI
 
     def github_project_name
       if !@github_project_name
-        origin = Git.new.origin
+        origin = Git.new(Executor.new).origin
         @github_project_name = origin.match("git@github.com:(.*)")[1]
       end
       @github_project_name
@@ -111,18 +124,18 @@ module YSI
           skipped_assertions << assertion
           next
         end
-        success = assertion.check
-        if success
-          out.puts success
-        else
-          if assertion.error
-            out.puts "error"
-            out.puts "  " + assertion.error
-            errored_assertions.push(assertion)
+        begin
+          success = assertion.check
+          if success
+            out.puts success
           else
             out.puts "fail"
             failed_assertions.push(assertion)
           end
+        rescue AssertionError => e
+          out.puts "error"
+          out.puts "  " + e.message
+          errored_assertions.push(assertion)
         end
       end
 
@@ -141,16 +154,15 @@ module YSI
           return 0
         else
           failed_assertions.each do |assertion|
-            if dry_run
+            if dry_run?
               out.print "Dry run: "
             end
             out.print "Asserting #{assertion.display_name}: "
-            success = assertion.assert(dry_run: dry_run)
-            if !success
-              if assertion.error
-                out.puts "error"
-                out.puts "  " + assertion.error
-              end
+            begin
+              success = assertion.assert(executor)
+            rescue AssertionError => e
+              out.puts "error"
+              out.puts "  " + e.message
               out.puts
               out.puts "Ran into an error. Stopping shipping."
               return 1
@@ -159,7 +171,7 @@ module YSI
           end
 
           out.puts
-          if dry_run
+          if dry_run?
             out.puts "Did a dry run of shipping #{project_name} #{version}." +
               " Nothing was changed."
           else

data/lib/yes_ship_it/exceptions.rb

@@ -1,4 +1,7 @@
 module YSI
   class Error < StandardError
   end
+
+  class AssertionError < StandardError
+  end
 end

data/lib/yes_ship_it/executor.rb

@@ -0,0 +1,37 @@
+module YSI
+  class Executor
+    def run_command(args, working_directory: Dir.pwd)
+      begin
+        Dir.chdir(working_directory) do
+          Cheetah.run(args, stdout: :capture)
+        end
+      rescue Cheetah::ExecutionFailed => e
+        raise YSI::AssertionError.new(e.message)
+      end
+    end
+
+    def http_post(url, data)
+      begin
+        RestClient.post(url, data)
+      rescue RestClient::Exception => e
+        raise YSI::AssertionError.new(e.message)
+      end
+    end
+
+    def http_put(url, data, options)
+      begin
+        RestClient.put(url, data, options)
+      rescue RestClient::Exception => e
+        raise YSI::AssertionError.new(e.message)
+      end
+    end
+
+    def http_delete(url)
+      begin
+        RestClient.delete(url)
+      rescue RestClient::Exception => e
+        raise YSI::AssertionError.new(e.message)
+      end
+    end
+  end
+end

data/lib/yes_ship_it/git.rb

@@ -1,29 +1,30 @@
 module YSI
   class Git
-    def initialize(working_dir = Dir.pwd)
+    def initialize(executor, working_dir = Dir.pwd)
+      @executor = executor
       @working_dir = working_dir
     end
 
     def run_git(args)
       Dir.chdir(@working_dir) do
-        `git #{args}`
+        @executor.run_command(["git"] + args)
       end
     end
 
     def origin
-      run_git("remote -v").match(/origin\s+(.*?)(\.git)?\s+\(push\)/)[1]
+      run_git(["remote", "-v"]).match(/origin\s+(.*?)(\.git)?\s+\(push\)/)[1]
     end
 
     def needs_push?
-      local_master = run_git("rev-parse master")
-      remote_master = run_git("rev-parse origin/master")
-      base = run_git("merge-base master origin/master")
+      local_master = run_git(["rev-parse", "master"])
+      remote_master = run_git(["rev-parse", "origin/master"])
+      base = run_git(["merge-base", "master", "origin/master"])
 
       remote_master == base && local_master != remote_master
     end
 
     def push
-      `git push`
+      run_git(["push"])
     end
   end
 end

data/lib/yes_ship_it/init.rb

@@ -0,0 +1,50 @@
+module YSI
+  class Init
+    attr_accessor :out
+
+    def initialize(path)
+      @path = path
+
+      @out = STDOUT
+    end
+
+    def setup_config
+      config_file = File.join(@path, "yes_ship_it.conf")
+
+      if File.exist?(config_file)
+        out.puts "There already is a file `yes_ship_it.conf`."
+        out.puts
+        out.puts "This project does not seem to need initialization."
+        return
+      end
+
+      out.puts "Initialized directory for shipping."
+      out.puts
+      File.open(config_file, "w") do |f|
+        f.puts "# Experimental release automation. See https://github.com/cornelius/yes_ship_it."
+        if File.exist?(File.join(@path, "lib", "version.rb"))
+          out.puts "It looks like this is is Ruby project."
+
+          f.puts "include:"
+          f.puts "  ruby_gem"
+        else
+          out.puts "Couldn't determine type of project, wrote a generic template."
+
+          f.puts "assertions:"
+          f.puts "  - release_branch"
+          f.puts "  - working_directory"
+          f.puts "  - version"
+          f.puts "  - change_log"
+          f.puts "  - tag"
+          f.puts "  - pushed_tag"
+          f.puts "  - pushed_code"
+          f.puts "  - yes_it_shipped"
+        end
+      end
+      out.puts
+      out.puts "Check the file `yes_ship_it.conf` and adapt it to your needs."
+      out.puts
+      out.puts "Happy shipping!"
+    end
+  end
+end

data/lib/yes_ship_it/plugin.rb

@@ -0,0 +1,76 @@
+module YSI
+  class Plugin
+    attr_accessor :out, :err
+
+    def initialize(path)
+      @plugin_dir = File.join(path, "yes_ship_it", "assertions")
+
+      @out = STDOUT
+      @err = STDERR
+    end
+
+    def load
+      plugin_paths = []
+      if File.exist?(@plugin_dir)
+        plugin_paths = Dir.glob("#{@plugin_dir}/*.rb").sort
+      end
+
+      plugins = {}
+      plugin_paths.each do |plugin_path|
+        plugin_name = File.basename(plugin_path, ".rb")
+        require plugin_path
+        plugins[plugin_name] = YSI::Assertion.class_for_name(plugin_name)
+      end
+
+      plugins
+    end
+
+    def list
+      plugins = load
+
+      if plugins.empty?
+        out.puts "There are no local plugins."
+        out.puts
+        out.puts "Create one with `yes_ship_it plugin init MyAssertion`."
+        out.puts
+        out.puts "Documentation about how to write plugins can be found at"
+        out.puts
+        out.puts "    https://github.com/cornelius/yes_ship_it/wiki/plugins"
+      else
+        plugins.each do |plugin_name, plugin_class|
+          out.puts "#{plugin_name}: #{plugin_class.display_name}"
+        end
+      end
+    end
+
+    def generate(name, display_name)
+      plugin_path = File.join(@plugin_dir, name + ".rb")
+
+      if File.exist?(plugin_path)
+        err.puts "Can't generate plugin. Plugin already exists at `#{plugin_path}`."
+        exit 1
+      end
+
+      FileUtils.mkdir_p(@plugin_dir)
+
+      File.open(plugin_path, "w") do |f|
+        f.puts "module YSI"
+        f.puts "  class #{YSI::Assertion.class_name(name)} < Assertion"
+        f.puts "    def self.display_name"
+        f.puts "      \"#{display_name}\""
+        f.puts "    end"
+        f.puts
+        f.puts "    def check"
+        f.puts "    end"
+        f.puts
+        f.puts "    def assert(executor)"
+        f.puts "      \"help me to do it\""
+        f.puts "    end"
+        f.puts "  end"
+        f.puts "end"
+      end
+
+      out.puts "Generated assertion plugin at `#{plugin_path}`."
+    end
+  end
+end

data/lib/yes_ship_it.rb

@@ -10,6 +10,10 @@ require_relative "yes_ship_it/assertion.rb"
 require_relative "yes_ship_it/engine.rb"
 require_relative "yes_ship_it/exceptions.rb"
 require_relative "yes_ship_it/git.rb"
+require_relative "yes_ship_it/executor.rb"
+require_relative "yes_ship_it/dry_executor.rb"
+require_relative "yes_ship_it/init.rb"
+require_relative "yes_ship_it/plugin.rb"
 
 assertions_dir = File.expand_path("../../assertions", __FILE__)
 Dir[File.join(assertions_dir, "*.rb")].each { |f| require(f) }

data/spec/data/init/ruby/lib/version.rb

@@ -0,0 +1,3 @@
+module YSI
+  VERSION = "0.0.5"
+end

data/spec/data/plugins/my_other_plugin.rb

@@ -0,0 +1,14 @@
+module YSI
+  class MyOtherPlugin < Assertion
+    def self.display_name
+      "My other even more awesome plugin"
+    end
+
+    def check
+    end
+
+    def assert(executor)
+      "done"
+    end
+  end
+end

data/spec/data/plugins/my_plugin.rb

@@ -0,0 +1,14 @@
+module YSI
+  class MyPlugin < Assertion
+    def self.display_name
+      "My awesome plugin"
+    end
+
+    def check
+    end
+
+    def assert(executor)
+      "help me to do it"
+    end
+  end
+end

data/spec/data/version/polkaversion.h

@@ -0,0 +1 @@
+#define POLKA_VERSION "0.8"

data/spec/data/yes_ship_it.plugins.conf

@@ -0,0 +1,4 @@
+assertions:
+  my_plugin:
+  my_other_plugin:
+  

data/spec/integration/cli_spec.rb

@@ -221,6 +221,33 @@ EOT
       file_list = `tar tzf #{release_archive}`.split("\n").sort
       expect(file_list).to eq(expected_file_list.split("\n").sort)
     end
+
+    it "loads plugins" do
+      dir = nil
+      given_directory do
+        dir = given_directory "red_herring" do
+          given_file("yes_ship_it.conf", from: "yes_ship_it.plugins.conf")
+          given_directory "yes_ship_it" do
+            given_directory_from_data "assertions", from: "plugins"
+          end
+        end
+      end
+
+      expected_output = <<EOT
+Shipping...
+
+Checking My awesome plugin: fail
+Checking My other even more awesome plugin: fail
+
+Dry run: Asserting My awesome plugin: help me to do it
+Dry run: Asserting My other even more awesome plugin: done
+
+Did a dry run of shipping red_herring . Nothing was changed.
+EOT
+      expect(run_command(args: ["--dry-run"],
+        working_directory: File.join(dir))).
+          to exit_with_success(expected_output)
+    end
   end
 
   describe "changelog helper" do
@@ -250,12 +277,29 @@ EOT
   end
 
   describe "init" do
+    it "fails if there already is a config" do
+      dir = given_directory do
+        given_dummy_file("yes_ship_it.conf")
+      end
+
+      expected_output = <<EOT
+There already is a file `yes_ship_it.conf`.
+
+This project does not seem to need initialization.
+EOT
+
+      expect(run_command(args: ["init"], working_directory: dir)).
+        to exit_with_success(expected_output)
+    end
+
     it "initializes directory with generic template" do
       dir = given_directory
 
       expected_output = <<EOT
 Initialized directory for shipping.
 
+Couldn't determine type of project, wrote a generic template.
+
 Check the file `yes_ship_it.conf` and adapt it to your needs.
 
 Happy shipping!
@@ -263,10 +307,118 @@ EOT
 
       expect(run_command(args: ["init"], working_directory: dir)).
         to exit_with_success(expected_output)
+    end
 
-      expect(File.read(File.join(dir, "yes_ship_it.conf"))).to eq(
-       "# Experimental release automation. See https://github.com/cornelius/yes_ship_it.\ninclude:\n  ruby_gem\n"
-      )
+    it "initializes directory with specific template" do
+      dir = nil
+      given_directory("init") do
+        dir = given_directory_from_data("ruby", from: "init/ruby" )
+      end
+
+      expected_output = <<EOT
+Initialized directory for shipping.
+
+It looks like this is is Ruby project.
+
+Check the file `yes_ship_it.conf` and adapt it to your needs.
+
+Happy shipping!
+EOT
+
+      expect(run_command(args: ["init"], working_directory: dir)).
+        to exit_with_success(expected_output)
+    end
+  end
+
+  describe "plugin" do
+    it "fails when no sub command is given" do
+      expect(run_command(args: ["plugin"])).to exit_with_error(1, /Invalid command/)
+    end
+
+    it "fails when invalid sub command is given" do
+      result = run_command(args: ["plugin", "xxx"])
+      expect(result).to exit_with_error(1, /Invalid command/)
+      expect(result.stderr).to match /Usage:/
+    end
+
+    describe "list" do
+      it "shows message when there are no plugins" do
+        dir = given_directory
+
+        expected_output = <<EOT
+There are no local plugins.
+
+Create one with `yes_ship_it plugin init MyAssertion`.
+
+Documentation about how to write plugins can be found at
+
+    https://github.com/cornelius/yes_ship_it/wiki/plugins
+EOT
+
+        expect(run_command(args: ["plugin", "list"], working_directory: dir)).
+          to exit_with_success(expected_output)
+      end
+
+      it "lists plugins" do
+        dir = given_directory do
+          given_directory "yes_ship_it" do
+            given_directory_from_data "assertions", from: "plugins"
+          end
+        end
+
+        expected_output = <<EOT
+my_other_plugin: My other even more awesome plugin
+my_plugin: My awesome plugin
+EOT
+
+        expect(run_command(args: ["plugin", "list"], working_directory: dir)).
+          to exit_with_success(expected_output)
+      end
+    end
+
+    describe "generate" do
+      it "fails when arguments are missing" do
+        expected_output = <<EOT
+Parameters are missing. Use for example
+
+    yes_ship_it plugin generate my_plugin "My plugin"
+
+to generate a plugin `my_plugin` with a display name of "My plugin".
+EOT
+        expect(run_command(args: ["plugin", "generate"])).to exit_with_error(1, expected_output)
+      end
+
+      it "fails when plugin already exists" do
+        dir = given_directory do
+          given_directory "yes_ship_it" do
+            given_directory "assertions" do
+              given_dummy_file "my_plugin.rb"
+            end
+          end
+        end
+
+        plugin_path = File.join(dir, "yes_ship_it", "assertions", "my_plugin.rb")
+
+        expected_output = <<EOT
+Can't generate plugin. Plugin already exists at `#{plugin_path}`.
+EOT
+        expect(run_command(args: ["plugin", "generate", "my_plugin", "My Plugin"], working_directory: dir)).
+          to exit_with_error(1, expected_output)
+      end
+
+      it "creates new plugin" do
+        dir = given_directory
+        plugin_path = File.join(dir, "yes_ship_it", "assertions", "my_plugin.rb")
+
+        expected_output = <<EOT
+Generated assertion plugin at `#{plugin_path}`.
+EOT
+        expect(run_command(args: ["plugin", "generate", "my_plugin", "My awesome plugin"], working_directory: dir)).
+          to exit_with_success(expected_output)
+
+        expected_code = File.read(given_file("plugins/my_plugin.rb"))
+        expect(File.read(plugin_path)).to eq(expected_code)
+      end
     end
   end
 end

data/spec/spec_helper.rb

@@ -1,5 +1,7 @@
 require "given_filesystem/spec_helpers"
 
+include GivenFilesystemSpecHelpers
+
 def setup_test_git_repo(version, dir)
   tarball = "spec/data/red_herring-#{version}.tar.gz"
   tarball_path = File.expand_path(tarball)

data/spec/system/dry_run_spec.rb

@@ -0,0 +1,59 @@
+require_relative "spec_helper"
+
+describe "dry run" do
+  before(:all) do
+    out = StringIO.new
+    @test = Httpotemkin::Test.new(out: out)
+    @test.add_server("rubygems")
+    @test.add_server("api.rubygems")
+    @test.add_server("obs")
+    @test.up
+  end
+
+  after(:all) do
+    @test.down
+  end
+
+  before(:each) do
+    @client = @test.start_client
+    @client.install_gem_from_spec("yes_ship_it.gemspec")
+    remote_tar = File.expand_path("../data/red_herring-remote.tar.gz", __FILE__)
+    @client.inject_tarball(remote_tar)
+  end
+
+  after(:each) do
+    @test.stop_client
+  end
+
+  it "doesn't do changes" do
+    checkout_tar = File.expand_path("../data/red_herring-checkout-dry-run.tar.gz", __FILE__)
+    @client.inject_tarball(checkout_tar)
+
+    @client.execute(["yes_ship_it.ruby2.1", "--dry-run"], working_directory: "red_herring")
+
+    expected_output = <<EOT
+Shipping...
+
+Checking release branch: master
+Checking working directory: clean
+Checking version number: 0.0.2
+Checking change log: CHANGELOG.md
+Checking tag: fail
+Checking built gem: fail
+Checking published gem: fail
+Checking pushed tag: fail
+Checking pushed code: fail
+
+Dry run: Asserting tag: v0.0.2
+Dry run: Asserting built gem: red_herring-0.0.2.gem
+Dry run: Asserting published gem: red_herring-0.0.2.gem
+Dry run: Asserting pushed tag: v0.0.2
+Dry run: Asserting pushed code: pushed
+
+Did a dry run of shipping red_herring 0.0.2. Nothing was changed.
+EOT
+    expect(@client.err).to eq("")
+    expect(@client.out).to eq(expected_output)
+    expect(@client.exit_code).to eq(0)
+  end
+end

data/spec/system/rpm_spec.rb

@@ -0,0 +1,62 @@
+require_relative "spec_helper"
+
+describe "rpm" do
+  before(:all) do
+    out = StringIO.new
+    @test = Httpotemkin::Test.new(out: out)
+    @test.add_server("rubygems")
+    @test.add_server("api.rubygems")
+    @test.add_server("obs")
+    @test.up
+  end
+
+  after(:all) do
+    @test.down
+  end
+
+  before(:each) do
+    @client = @test.start_client
+    @client.install_gem_from_spec("yes_ship_it.gemspec")
+    remote_tar = File.expand_path("../data/red_herring-remote.tar.gz", __FILE__)
+    @client.inject_tarball(remote_tar)
+  end
+
+  after(:each) do
+    @test.stop_client
+  end
+
+  it "pushes to obs" do
+    checkout_tar = File.expand_path("../data/red_herring-checkout-rpm.tar.gz", __FILE__)
+    @client.inject_tarball(checkout_tar)
+
+    @client.execute(["yes_ship_it.ruby2.1"], working_directory: "red_herring")
+
+    expected_output = <<EOT
+Shipping...
+
+Checking release branch: master
+Checking working directory: clean
+Checking version number: 0.0.2
+Checking change log: CHANGELOG.md
+Checking tag: fail
+Checking release archive: fail
+Checking submitted RPM: fail
+Checking pushed tag: fail
+Checking pushed code: fail
+
+Asserting tag: v0.0.2
+Asserting release archive: red_herring-0.0.2.tar.gz
+Asserting submitted RPM: ...
+  Uploading release archive 'red_herring-0.0.2.tar.gz'
+  Uploading spec file 'red_herring.spec'
+... home:cschum:go/red_herring
+Asserting pushed tag: v0.0.2
+Asserting pushed code: pushed
+
+Shipped red_herring 0.0.2. Hooray!
+EOT
+    expect(@client.err).to eq("")
+    expect(@client.out).to eq(expected_output)
+    expect(@client.exit_code).to eq(0)
+  end
+end