yes_ship_it 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 444ecc2191ed065ffeb7d23921a8518897ef5f59
+  data.tar.gz: 41ccaa7257b29964108a58bd27ddd5a9519984b8
+SHA512:
+  metadata.gz: e5ab4853e2fd9337988199767d0264046b49f3122c773bda25d15d0f182f9f75caa73fa30764cb6dfa4c53fc72b1dafb52ccdba7ed625a9fafbf2d2599042afb
+  data.tar.gz: 9396162f0020b8ce79e9fc15475010f41b0da38a55c3f677172436a12e1c2d61b3a8d5152a07721688f1f5ab7037b6d9fc78d1a6323d3eb12da132c9a7fb84c4

data/.rspec

@@ -0,0 +1 @@
+--color

data/README.md

@@ -0,0 +1,108 @@
+# Yes, ship it!
+
+*The ultimate release script*
+
+Whenever the answer is "Yes, ship it!" you will need `yes_ship_it`, this tool.
+It is the ultimate helper in releasing software.
+
+Shipping software is not an action. It's a state of mind. `yes_ship_it` helps
+you to make sure that reality matches this state of mind. It won't fix the bugs
+in your software, it doesn't create the tests which would need to be there, it
+doesn't write your release notes. It does make sure that your good engineering
+is delivered to your users with zero cost.
+
+The approach of `yes_ship_it` is different from the typical release script. It
+doesn't define a series of steps which are executed to make a release. It
+defines a sequence of assertions about the release, which then are checked and
+enforced.
+
+This works in a way you could describe as idempotent, which means you
+can execute it as many times as you want, the result will always be the same,
+regardless of the initial state. That means the whole process is robust against
+errors which happen during releasing, it transparently copes with manual tweaks
+and changes, and it works on old releases just as well as on new releases.
+
+After successfully running `yes_ship_it` your release will have shipped, and the
+state of the world will reflect the state of your mind.
+
+## Assumptions
+
+`yes_ship_it` assumes that you develop your software in a version control
+system and keep at least some minimal state of releases there. This could just
+be a tag. It also assumes that you are able to run `yes_ship_it` from the
+command line and have some access to the systems which are needed to complete
+the things part of a release.
+
+## How to run it
+
+Go to the checkout of the sources of your software. Check that there is a file
+called `yes_ship_it.conf` there. Run `yes_ship_it`. Done.
+
+## Configuration
+
+The central configuration of what happens when you run `yes_ship_it` is the
+`yes_ship_it.conf` file in the root directory of the sources of your software.
+There you define the sequence of assertions which are run through for making
+sure that the release is happening in the way you intend. `yes_ship_it` comes
+with some predefined sequences of assertions you can simply reuse.
+
+The format of `yes_ship_it.conf` uses YAML. A minimal `yes_ship_it.conf` file
+could look like this:
+
+```yaml
+include:
+  standard_rubygem
+```
+
+A more detailed configuration could look like this:
+
+```yaml
+assertions:
+  ci_green
+  release_notes
+  version_number
+  gem_built
+  release_tagged
+  gem_pushed
+```
+
+There can be more configuration on a general level or the level of the
+assertions to adjust to specific needs of each software project. There also can
+be other or additional assertions.
+
+## Extending `yes_ship_it`
+
+Many software projects will have specific needs for their releases. These can
+be broken down and reflected in additional assertions. Adding assertions is
+easy. There is a well-defined API for it.
+
+There is no supported plugin concept. The idea is that all assertions ship with
+`yes_ship_it`. This will maximize the value for the community of people who ship
+software. The project is very open to include new assertions. Just submit a pull
+request. `yes_ship_it` will ship it with the next release.
+
+## Testing
+
+Testing a tool such as `yes_ship_it` is not easy because its prime functionality
+is to interact with other systems and publish data. There are unit tests for the
+code. There also are integration tests which work in a virtual environment which
+fakes the services `yes_ship_it` interacts with. It uses the `pennyworth` tool
+to manage the virtual environment and make them accessible in a convenient way
+from the RSpec tests.
+
+## Further documentation
+
+You get basic documentation from the tool itself by executing
+`yes_ship_it help`. There also is a simple man page with some pointers.
+
+The main documentation with details about different scenarios how `yes_ship_it`
+can be used is maintained in the Wiki. You are welcome to contribute there.
+
+## License
+
+`yes_ship_it` is licensed under the MIT license.
+
+## Contact
+
+If you have any questions or comments, please don't hesitate to get in touch
+with me: Cornelius Schumacher <schumacher@kde.org>.

data/assertions/built_gem.rb

@@ -0,0 +1,43 @@
+module YSI
+  class BuiltGem < Assertion
+    attr_accessor :error
+
+    def initialize(engine)
+      @engine = engine
+    end
+
+    def display_name
+      "built gem"
+    end
+
+    def gem_file
+      "#{@engine.project_name}-#{@engine.version}.gem"
+    end
+
+    def gemspec_file
+      "#{@engine.project_name}.gemspec"
+    end
+
+    def check
+      if !File.exist?(gemspec_file)
+        @error = "I need a gemspec: #{gemspec_file}"
+        return nil
+      end
+
+      if !File.exist?(gem_file)
+        return nil
+      end
+
+      gem_file
+    end
+
+    def assert(dry_run: false)
+      if !dry_run
+        if !system("gem build #{gemspec_file}")
+          return nil
+        end
+      end
+      gem_file
+    end
+  end
+end

data/assertions/change_log.rb

@@ -0,0 +1,25 @@
+module YSI
+  class ChangeLog < Assertion
+    attr_reader :error
+
+    def initialize(engine)
+      @engine = engine
+    end
+
+    def display_name
+      "change log"
+    end
+
+    def check
+      if !File.exist?("CHANGELOG.md")
+        @error = "Expected change log in CHANGELOG.md"
+        return nil
+      end
+
+      "CHANGELOG.md"
+    end
+
+    def assert(dry_run: false)
+    end
+  end
+end

data/assertions/published_gem.rb

@@ -0,0 +1,39 @@
+module YSI
+  class PublishedGem < Assertion
+    attr_accessor :error
+
+    def initialize(engine)
+      @engine = engine
+    end
+
+    def display_name
+      "published gem"
+    end
+
+    def gem_file
+      "#{@engine.project_name}-#{@engine.version}.gem"
+    end
+
+    def check
+      begin
+        json = RestClient.get("http://rubygems.org/api/v1/versions/#{engine.project_name}.json")
+      rescue RestClient::ResourceNotFound
+        return nil
+      end
+      versions = JSON.parse(json)
+      versions.each do |version|
+        if version["number"] == @engine.version
+          return @engine.version
+        end
+      end
+      nil
+    end
+
+    def assert(dry_run: false)
+      if !dry_run
+        `gem push #{gem_file}`
+      end
+      gem_file
+    end
+  end
+end

data/assertions/pushed_tag.rb

@@ -0,0 +1,27 @@
+module YSI
+  class PushedTag < Assertion
+    def display_name
+      "pushed tag"
+    end
+
+    def tag
+      "v#{@engine.version}"
+    end
+
+    def check
+      response = `git ls-remote --tags origin #{tag}`
+      if response.include?(tag)
+        return response
+      end
+
+      nil
+    end
+
+    def assert(dry_run: false)
+      if !dry_run
+        `git push --tags`
+      end
+      tag
+    end
+  end
+end

data/assertions/tag.rb

@@ -0,0 +1,32 @@
+module YSI
+  class Tag < Assertion
+    def display_name
+      "tag"
+    end
+
+    def tag
+      "v#{@engine.version}"
+    end
+
+    def check
+      `git tag`.each_line do |line|
+        if line.chomp == tag
+          `git show #{tag}`.each_line do |show_line|
+            if show_line =~ /Date:\s+(.*)/
+              @engine.tag_date = $1
+            end
+          end
+          return tag
+        end
+      end
+      return nil
+    end
+
+    def assert(dry_run: false)
+      if !dry_run
+        `git tag -a #{tag} -m "Version #{@engine.version}"`
+      end
+      tag
+    end
+  end
+end

data/assertions/version.rb

@@ -0,0 +1,33 @@
+module YSI
+  class Version < Assertion
+    attr_accessor :error
+
+    def initialize(engine)
+      @engine = engine
+    end
+
+    def display_name
+      "version number"
+    end
+
+    def check
+      version_file = "lib/version.rb"
+      if !File.exist?(version_file)
+        @error = "Expected version in #{version_file}"
+        return nil
+      end
+
+      File.read(version_file).each_line do |line|
+        if line =~ /VERSION = "(.*)"/
+          @engine.version = $1
+          return @engine.version
+        end
+      end
+      @error = "Couldn't find version in #{version_file}"
+      nil
+    end
+
+    def assert(dry_run: false)
+    end
+  end
+end

data/bin/yes_ship_it

@@ -0,0 +1,25 @@
+#!/usr/bin/ruby
+
+require_relative("../lib/yes_ship_it.rb")
+
+puts "Shipping..."
+puts
+
+config_file = "yes_ship_it.conf"
+
+if !File.exist?(config_file)
+  STDERR.puts("Unable to find file `yes_ship_it.conf`. I need it.")
+  exit 1
+end
+
+engine = YSI::Engine.new
+engine.dry_run = ARGV == ["--dry-run"]
+
+begin
+  engine.read(config_file)
+
+  exit engine.run
+rescue YSI::Error => e
+  STDERR.puts e
+  exit 1
+end

data/lib/yes_ship_it/assertion.rb

@@ -0,0 +1,10 @@
+module YSI
+  class Assertion
+    attr_reader :error
+    attr_accessor :engine
+
+    def initialize(engine)
+      @engine = engine
+    end
+  end
+end

data/lib/yes_ship_it/engine.rb

@@ -0,0 +1,104 @@
+module YSI
+  class Engine
+    attr_reader :assertions
+    attr_accessor :version, :tag_date
+    attr_accessor :out
+    attr_accessor :dry_run
+
+    def self.class_for_assertion_name(name)
+      class_name = name.split("_").map { |n| n.capitalize }.join
+      begin
+        Object.const_get("YSI::" + class_name)
+      rescue NameError
+        raise YSI::Error.new("Error: Unknown assertion '#{name}'")
+      end
+    end
+
+    def initialize
+      @assertions = []
+      @out = STDOUT
+    end
+
+    def read(filename)
+      config = YAML.load_file(filename)
+
+      assertions = config["assertions"]
+      if assertions
+        assertions.each do |assertion|
+          if assertion == "version_number"
+            out.puts "Warning: use `version` instead of `version_number`."
+            out.puts
+            assertion = "version"
+          end
+
+          @assertions << YSI::Engine.class_for_assertion_name(assertion).new(self)
+        end
+      end
+    end
+
+    def project_name
+      File.basename(Dir.pwd)
+    end
+
+    def run
+      failed_assertions = []
+      errored_assertions = []
+
+      @assertions.each do |assertion|
+        out.print "Checking #{assertion.display_name}: "
+        success = assertion.check
+        if success
+          out.puts success
+        else
+          if assertion.error
+            out.puts "error"
+            out.puts "  " + assertion.error
+            errored_assertions.push(assertion)
+          else
+            out.puts "fail"
+            failed_assertions.push(assertion)
+          end
+        end
+      end
+
+      out.puts
+
+      if !errored_assertions.empty?
+        out.puts "Couldn't ship #{project_name}. Help me."
+        return 1
+      else
+        if failed_assertions.empty?
+          if tag_date
+            out.puts "#{project_name} #{version} already shipped on #{tag_date}"
+          else
+            out.puts "#{project_name} #{version} already shipped"
+          end
+          return 0
+        else
+          failed_assertions.each do |assertion|
+            if dry_run
+              out.print "Dry run: "
+            end
+            out.print "Asserting #{assertion.display_name}: "
+            success = assertion.assert(dry_run: dry_run)
+            if !success
+              out.puts
+              out.puts "Ran into an error. Stopping shipping."
+              return 1
+            end
+            out.puts success
+          end
+
+          out.puts
+          if dry_run
+            out.puts "Did a dry run of shipping #{project_name} #{version}." +
+              " Nothing was changed."
+          else
+            out.puts "Shipped #{project_name} #{version}. Hooray!"
+          end
+          return 0
+        end
+      end
+    end
+  end
+end

data/lib/yes_ship_it/exceptions.rb

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

data/lib/yes_ship_it.rb

@@ -0,0 +1,9 @@
+require "yaml"
+require "rest-client"
+
+require_relative "yes_ship_it/assertion.rb"
+require_relative "yes_ship_it/engine.rb"
+require_relative "yes_ship_it/exceptions.rb"
+
+assertions_dir = File.expand_path("../../assertions", __FILE__)
+Dir[File.join(assertions_dir, "*.rb")].each { |f| require(f) }

data/spec/data/yes_ship_it.conf

@@ -0,0 +1,3 @@
+assertions:
+  - version
+  - change_log

data/spec/data/yes_ship_it.unknown.conf

@@ -0,0 +1,4 @@
+assertions:
+  - version
+  - change_log
+  - xyz

data/spec/integration/cli_spec.rb

@@ -0,0 +1,123 @@
+require_relative "spec_helper"
+
+include CliTester
+include GivenFilesystemSpecHelpers
+
+describe "command line interface" do
+  use_given_filesystem(keep_files: true)
+
+  it "does not find yes_ship_it.conf" do
+    dir = given_directory
+    expect(run_command(working_directory: dir)).to exit_with_error(1, /yes_ship_it.conf/)
+  end
+
+  describe "runs" do
+    it "fails when version is not there" do
+      dir = given_directory
+
+      setup_test_git_repo("000", dir)
+
+      expected_output = <<EOT
+Shipping...
+
+Warning: use `version` instead of `version_number`.
+
+Checking version number: error
+  Expected version in lib/version.rb
+Checking change log: error
+  Expected change log in CHANGELOG.md
+
+Couldn't ship red_herring. Help me.
+EOT
+
+      expect(run_command(working_directory: File.join(dir, "red_herring"))).
+        to exit_with_error(1, "", expected_output)
+    end
+
+    it "succeeds when all checks are met" do
+      dir = given_directory
+
+      setup_test_git_repo("001", dir)
+
+      expected_output = <<EOT
+Shipping...
+
+Warning: use `version` instead of `version_number`.
+
+Checking version number: 0.0.1
+Checking change log: CHANGELOG.md
+
+red_herring 0.0.1 already shipped
+EOT
+
+      expect(run_command(working_directory: File.join(dir, "red_herring"))).
+        to exit_with_success(expected_output)
+    end
+
+    it "succeeds when tag is there" do
+      dir = given_directory
+
+      setup_test_git_repo("002", dir)
+
+      expected_output = <<EOT
+Shipping...
+
+Warning: use `version` instead of `version_number`.
+
+Checking version number: 0.0.1
+Checking change log: CHANGELOG.md
+Checking tag: v0.0.1
+
+red_herring 0.0.1 already shipped on Wed Jul 1 00:46:19 2015 +0200
+EOT
+
+      expect(run_command(working_directory: File.join(dir, "red_herring"))).
+        to exit_with_success(expected_output)
+    end
+
+    it "fails when gem is not built" do
+      dir = given_directory
+
+      setup_test_git_repo("003", dir)
+
+      expected_output = <<EOT
+Shipping...
+
+Checking version number: 0.0.1
+Checking change log: CHANGELOG.md
+Checking built gem: fail
+Checking tag: v0.0.1
+
+Asserting built gem: red_herring-0.0.1.gem
+
+Shipped red_herring 0.0.1. Hooray!
+EOT
+
+      expect(run_command(working_directory: File.join(dir, "red_herring"))).
+        to exit_with_success(expected_output)
+    end
+
+    it "processes the --dry-run option" do
+      dir = given_directory
+
+      setup_test_git_repo("003", dir)
+
+      expected_output = <<EOT
+Shipping...
+
+Checking version number: 0.0.1
+Checking change log: CHANGELOG.md
+Checking built gem: fail
+Checking tag: v0.0.1
+
+Dry run: Asserting built gem: red_herring-0.0.1.gem
+
+Did a dry run of shipping red_herring 0.0.1. Nothing was changed.
+EOT
+
+      expect(run_command(args: ["--dry-run"],
+        working_directory: File.join(dir, "red_herring"))).
+        to exit_with_success(expected_output)
+    end
+  end
+end

data/spec/integration/spec_helper.rb

@@ -0,0 +1,10 @@
+require "cli_tester"
+require "given_filesystem/spec_helpers"
+
+def setup_test_git_repo(version, dir)
+  tarball = "spec/data/red_herring-#{version}.tar.gz"
+  tarball_path = File.expand_path(tarball)
+  if !system("cd #{dir}; tar xzf #{tarball_path}")
+    raise "Unable to extract tarball #{tarball}"
+  end
+end

data/spec/unit/assertions_spec.rb

@@ -0,0 +1,13 @@
+require_relative "spec_helper"
+
+describe "all assertions" do
+  all_classes = ObjectSpace.each_object(Class).select { |klass| klass < YSI::Assertion }
+
+  all_classes.each do |assertion_class|
+    describe assertion_class do
+      it_behaves_like "an assertion" do
+        let(:assertion) {assertion_class.new(YSI::Engine.new) }
+      end
+    end
+  end
+end

data/spec/unit/engine_spec.rb

@@ -0,0 +1,68 @@
+require_relative "spec_helper.rb"
+
+include GivenFilesystemSpecHelpers
+
+describe YSI::Engine do
+  use_given_filesystem
+
+  describe "#class_for_assertion_name" do
+    it "creates VersionNumber class" do
+      expect(YSI::Engine.class_for_assertion_name("version")).
+        to be(YSI::Version)
+    end
+
+    it "creates ChangeLog class" do
+      expect(YSI::Engine.class_for_assertion_name("change_log")).
+        to be(YSI::ChangeLog)
+    end
+  end
+
+  describe "#read" do
+    it "reads valid configuration" do
+      path = nil
+      given_directory do
+        path = given_file("yes_ship_it.conf")
+      end
+
+      ysi = YSI::Engine.new
+
+      ysi.read(path)
+
+      expect(ysi.assertions.count).to eq(2)
+      expect(ysi.assertions[0].class).to eq(YSI::Version)
+      expect(ysi.assertions[1].class).to eq(YSI::ChangeLog)
+    end
+
+    it "fails on configuration with unknown assertions" do
+      path = nil
+      given_directory do
+        path = given_file("yes_ship_it.conf", from: "yes_ship_it.unknown.conf")
+      end
+
+      ysi = YSI::Engine.new
+
+      expect {
+        ysi.read(path)
+      }.to raise_error YSI::Error
+    end
+  end
+
+  it "runs assertions" do
+    path = nil
+    given_directory do
+      path = given_file("yes_ship_it.conf")
+    end
+
+    ysi = YSI::Engine.new
+
+    ysi.read(path)
+
+    ysi.assertions.each do |a|
+      expect(a).to receive(:check)
+    end
+
+    ysi.out = StringIO.new
+
+    ysi.run
+  end
+end

data/spec/unit/spec_helper.rb

@@ -0,0 +1,5 @@
+require_relative "../../lib/yes_ship_it.rb"
+
+support = File.expand_path("../support", __FILE__) + "/*.rb"
+
+Dir[support].each { |f| require f }

data/spec/unit/support/assertion_examples.rb

@@ -0,0 +1,21 @@
+shared_examples "an assertion" do
+  it "initializes with an engine" do
+    expect(assertion.engine).to be_a(YSI::Engine)
+  end
+
+  it "has a display name" do
+    expect(assertion.display_name).to be_a(String)
+  end
+
+  it "checks" do
+    expect(assertion).to respond_to(:check)
+  end
+
+  it "asserts" do
+    expect(assertion).to respond_to(:assert)
+  end
+
+  it "reports errors" do
+    expect(assertion).to respond_to(:error)
+  end
+end

data/yes_ship_it.conf

@@ -0,0 +1,9 @@
+# Experimental release automation. See https://github.com/cornelius/yes_ship_it.
+
+assertions:
+  - version
+  - change_log
+  - built_gem
+  - published_gem
+  - tag
+  - pushed_tag

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: yes_ship_it
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Cornelius Schumacher
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-07-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: given_filesystem
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: cli_tester
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Whenever the answer is 'Yes, ship it!' you will need yes_ship_it. It
+  is the ultimate helper in releasing software..
+email:
+- schumacher@kde.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .rspec
+- README.md
+- assertions/built_gem.rb
+- assertions/change_log.rb
+- assertions/published_gem.rb
+- assertions/pushed_tag.rb
+- assertions/tag.rb
+- assertions/version.rb
+- bin/yes_ship_it
+- lib/yes_ship_it.rb
+- lib/yes_ship_it/assertion.rb
+- lib/yes_ship_it/engine.rb
+- lib/yes_ship_it/exceptions.rb
+- spec/data/red_herring-000.tar.gz
+- spec/data/red_herring-001.tar.gz
+- spec/data/red_herring-002.tar.gz
+- spec/data/red_herring-003.tar.gz
+- spec/data/yes_ship_it.conf
+- spec/data/yes_ship_it.unknown.conf
+- spec/integration/cli_spec.rb
+- spec/integration/spec_helper.rb
+- spec/unit/assertions_spec.rb
+- spec/unit/engine_spec.rb
+- spec/unit/spec_helper.rb
+- spec/unit/support/assertion_examples.rb
+- yes_ship_it.conf
+homepage: http://github.com/cornelius/yes_ship_it
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project: yes_ship_it
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: The ultimate release script
+test_files: []
+has_rdoc: