dco 1.0.0

data/spec/sign_spec.rb

@@ -0,0 +1,230 @@
+#
+# Copyright 2016, Noah Kantrowitz
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'spec_helper'
+
+describe 'dco sign' do
+  # Create a branch structure for all tests.
+  git_init
+  file 'testing', 'one'
+  before do
+    cmds = [
+      'git add testing',
+      'git commit -m "first commit"',
+      'echo two > testing',
+      'git commit -a -m "second commit"',
+      'git checkout -b mybranch',
+    ]
+    command cmds.join(' && ')
+  end
+
+  context 'with no commits in the branch' do
+    dco_command 'sign -y mybranch'
+
+    it do
+      expect(subject.exitstatus).to eq 1
+      expect(subject.stderr).to eq "Branch mybranch has no commits which require sign-off\n"
+    end
+  end # /context with no commits in the branch
+
+  context 'with one commit in the branch' do
+    before do
+      command 'echo three > testing && git commit -a -m "first branch commit"'
+    end
+    dco_command 'sign -y mybranch'
+
+    it do
+      expect(subject.exitstatus).to eq 0
+      expect(subject.stdout).to match /^Developer's Certificate of Origin 1\.1$/
+      expect(subject.stdout).to match /^Going to sign-off the following commits:\n\* \h{7} Alan Smithee <asmithee@example\.com> first branch commit$/
+      expect(repo.log[0].message).to eq "first branch commit\n\nSigned-off-by: Alan Smithee <asmithee@example.com>"
+      expect(repo.log[1].message).to eq "second commit"
+      expect(repo.log[2].message).to eq "first commit"
+    end
+  end # /context with one commit in the branch
+
+  context 'with one commit in the branch without -y' do
+    before do
+      command 'echo three > testing && git commit -a -m "first branch commit"'
+    end
+    dco_command 'sign mybranch'
+
+    it do
+      expect(subject.exitstatus).to eq 1
+      expect(subject.stderr).to eq "Not signing off on commits without approval\n"
+    end
+  end # /context with one commit in the branch without -y
+
+  context 'with two commits in the branch' do
+    before do
+      command 'echo three > testing && git commit -a -m "first branch commit" && echo four > testing && git commit -a -m "second branch commit"'
+    end
+    dco_command 'sign -y mybranch'
+
+    it do
+      expect(subject.exitstatus).to eq 0
+      expect(subject.stdout).to match /^Developer's Certificate of Origin 1\.1$/
+      expect(subject.stdout).to match /^Going to sign-off the following commits:\n\* \h{7} Alan Smithee <asmithee@example\.com> second branch commit\n\* \h{7} Alan Smithee <asmithee@example\.com> first branch commit$/
+      expect(repo.log[0].message).to eq "second branch commit\n\nSigned-off-by: Alan Smithee <asmithee@example.com>"
+      expect(repo.log[1].message).to eq "first branch commit\n\nSigned-off-by: Alan Smithee <asmithee@example.com>"
+      expect(repo.log[2].message).to eq "second commit"
+      expect(repo.log[3].message).to eq "first commit"
+    end
+  end # /context with two commits in the branch
+
+  context 'with a branch that has a merge commit' do
+    before do
+      command('echo three > other && ' \
+        'git add other && ' \
+        'git commit -a -m "first branch commit" && ' \
+        'git checkout master && ' \
+        'echo three > testing && ' \
+        'git commit -a -m "third commit" && ' \
+        'git checkout mybranch && ' \
+        'git merge master && ' \
+        'echo four > other && ' \
+        'git commit -a -m "second branch commit"')
+    end
+    dco_command 'sign -y mybranch'
+
+    it do
+      expect(subject.exitstatus).to eq 0
+      expect(subject.stdout).to match /^Developer's Certificate of Origin 1\.1$/
+      expect(subject.stdout).to match /^Going to sign-off the following commits:\n\* \h{7} Alan Smithee <asmithee@example\.com> second branch commit\n\* \h{7} Alan Smithee <asmithee@example\.com> Merge branch 'master' into mybranch\n\* \h{7} Alan Smithee <asmithee@example\.com> first branch commit$/
+      # Ordering is unstable because of the merge.
+      commits = repo.log.map {|c| c.message }
+      expect(commits.size).to eq 6
+      expect(commits).to include "second branch commit\n\nSigned-off-by: Alan Smithee <asmithee@example.com>"
+      expect(commits).to include "Merge branch 'master' into mybranch\n\nSigned-off-by: Alan Smithee <asmithee@example.com>"
+      expect(commits).to include "first branch commit\n\nSigned-off-by: Alan Smithee <asmithee@example.com>"
+      expect(commits).to include "third commit"
+      expect(commits).to include "second commit"
+      expect(commits).to include "first commit"
+    end
+  end # /context with a branch that has a merge commit
+
+  context 'with behalf mode enabled' do
+    before do
+      command 'echo three > testing && git commit -a -m "first branch commit" && echo four > testing && git commit -a -m "second branch commit"'
+      git_init(name: 'Commiter McCommiterface', email: 'other@example.com')
+    end
+    dco_command 'sign -y mybranch -b https://github.com/chef/chef/pulls/1234'
+
+    it do
+      expect(subject.exitstatus).to eq 0
+      expect(subject.stdout).to_not match /^Developer's Certificate of Origin 1\.1$/
+      expect(subject.stdout).to match /^Going to sign-off the following commits:\n\* \h{7} Alan Smithee <asmithee@example\.com> second branch commit\n\* \h{7} Alan Smithee <asmithee@example\.com> first branch commit$/
+      expect(repo.log[0].message).to eq "second branch commit\n\nSigned-off-by: Alan Smithee <asmithee@example.com>\nSign-off-executed-by: Commiter McCommiterface <other@example.com>\nApproved-at: https://github.com/chef/chef/pulls/1234"
+      expect(repo.log[1].message).to eq "first branch commit\n\nSigned-off-by: Alan Smithee <asmithee@example.com>\nSign-off-executed-by: Commiter McCommiterface <other@example.com>\nApproved-at: https://github.com/chef/chef/pulls/1234"
+      expect(repo.log[2].message).to eq "second commit"
+      expect(repo.log[3].message).to eq "first commit"
+    end
+  end # /context with behalf mode enabled
+
+  context 'with someone elses commits' do
+    before do
+      command 'echo three > testing && git commit -a -m "first branch commit" && echo four > testing && git commit -a -m "second branch commit"'
+      git_init(name: 'Commiter McCommiterface', email: 'other@example.com')
+    end
+    dco_command 'sign -y mybranch'
+
+    it do
+      expect(subject.exitstatus).to eq 1
+      expect(subject.stderr).to eq "Branch mybranch contains commits not authored by you. Please use the --behalf flag when signing off for another contributor\n"
+    end
+  end # /context with someone elses commits
+
+  context 'with an invalid branch' do
+    dco_command 'sign -y master'
+
+    it do
+      expect(subject.exitstatus).to eq 1
+      expect(subject.stderr).to eq "Cannot use master for both the base and target branch\n"
+    end
+  end # /context with an invalid branch
+
+  context 'with an implicit branch' do
+    before do
+      command 'echo three > testing && git commit -a -m "first branch commit"'
+    end
+    dco_command 'sign -y'
+
+    it do
+      expect(subject.exitstatus).to eq 0
+      expect(subject.stdout).to match /^Developer's Certificate of Origin 1\.1$/
+      expect(subject.stdout).to match /^Going to sign-off the following commits:\n\* \h{7} Alan Smithee <asmithee@example\.com> first branch commit$/
+      expect(repo.log[0].message).to eq "first branch commit\n\nSigned-off-by: Alan Smithee <asmithee@example.com>"
+      expect(repo.log[1].message).to eq "second commit"
+      expect(repo.log[2].message).to eq "first commit"
+    end
+  end # /context with an implicit branch
+
+  context 'with an implicit invalid branch' do
+    before { command 'git checkout master' }
+    dco_command 'sign -y'
+
+    it do
+      expect(subject.exitstatus).to eq 1
+      expect(subject.stderr).to eq "Cannot use master for both the base and target branch\n"
+    end
+  end # /context with an implicit invalid branch
+
+  context 'with an existing backup pointer' do
+    before do
+      command 'echo three > testing && git commit -a -m "first branch commit"'
+      dco_command 'sign -y mybranch'
+      command 'echo four > testing && git commit -a -m "second branch commit"'
+    end
+    dco_command 'sign -y mybranch'
+
+    it do
+      expect(subject.exitstatus).to eq 0
+      expect(subject.stdout).to match /^Developer's Certificate of Origin 1\.1$/
+      expect(subject.stdout).to match /^Going to sign-off the following commits:\n\* \h{7} Alan Smithee <asmithee@example\.com> second branch commit$/
+      expect(repo.log[0].message).to eq "second branch commit\n\nSigned-off-by: Alan Smithee <asmithee@example.com>"
+      expect(repo.log[1].message).to eq "first branch commit\n\nSigned-off-by: Alan Smithee <asmithee@example.com>"
+      expect(repo.log[2].message).to eq "second commit"
+      expect(repo.log[3].message).to eq "first commit"
+    end
+  end # /context with an existing backup pointer
+
+  context 'with an existing backup pointer without -y' do
+    before do
+      command 'echo three > testing && git commit -a -m "first branch commit"'
+      dco_command 'sign -y mybranch'
+      command 'echo four > testing && git commit -a -m "second branch commit"'
+    end
+    dco_command 'sign mybranch'
+
+    it do
+      expect(subject.exitstatus).to eq 1
+      expect(subject.stderr).to eq "Backup ref present, not continuing\n"
+    end
+  end # /context with an existing backup pointer without -y
+
+  context 'with uncommitted changes' do
+    before do
+      command 'echo three > testing && git commit -a -m "first branch commit" && echo four > testing'
+    end
+    dco_command 'sign -y mybranch'
+
+    it do
+      expect(subject.exitstatus).to eq 0
+      expect(subject.stdout).to match /^Stashing uncommited changes before continuing$/
+      expect(IO.read(File.join(temp_path, 'testing')).strip).to eq "four"
+    end
+  end # /context with uncommitted changes
+end

data/spec/spec_helper.rb

@@ -0,0 +1,91 @@
+#
+# Copyright 2016, Noah Kantrowitz
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'rspec'
+require 'rspec_command'
+require 'simplecov'
+require 'git'
+require 'shellwords'
+
+# Check for coverage stuffs
+if ENV['CODECOV_TOKEN'] || ENV['TRAVIS']
+  require 'codecov'
+  SimpleCov.formatter = SimpleCov::Formatter::Codecov
+end
+
+SimpleCov.start do
+  # Don't get coverage on the test cases themselves.
+  add_filter '/spec/'
+  add_filter '/test/'
+  # Codecov doesn't automatically ignore vendored files.
+  add_filter '/vendor/'
+end
+
+require 'dco'
+
+module DcoSpecHelper
+  extend RSpec::SharedContext
+
+  def dco_command *args
+    cwd = Dir.pwd
+    begin
+      Dir.chdir(temp_path)
+      capture_output do
+        args = Shellwords.split(args.first) if args.length == 1 && args.first.is_a?(String)
+        Dco::CLI.start(args)
+      end
+    ensure
+      Dir.chdir(cwd)
+    end
+  rescue Exception => e
+    status  = e.is_a?(SystemExit) ? e.status : 1
+    e.output_so_far.define_singleton_method(:exitstatus) { status }
+    e.output_so_far
+  end
+
+  def git_init(name: 'Alan Smithee', email: 'asmithee@example.com')
+    command "git init && git config user.name \"#{name}\" && git config user.email \"#{email}\""
+  end
+
+  let(:repo) { Git.open(temp_path) }
+
+  module ClassMethods
+    def dco_command *args
+      subject { dco_command(*args) }
+    end
+
+    def git_init(*args)
+      before { git_init(*args) }
+    end
+  end
+end
+
+RSpec.configure do |config|
+  # Basic configuraiton
+  config.run_all_when_everything_filtered = true
+  config.filter_run(:focus)
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+
+  config.include RSpecCommand
+
+  config.include DcoSpecHelper
+  config.extend DcoSpecHelper::ClassMethods
+end

metadata

@@ -0,0 +1,221 @@
+--- !ruby/object:Gem::Specification
+name: dco
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Noah Kantrowitz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-10-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: git
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: rspec-command
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: fuubar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: codecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.2
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: A command line tool to help manage Developer Certificate of Origin projects.
+email:
+- noah@coderanger.net
+executables:
+- dco
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- ".yardopts"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- appveyor.yml
+- bin/dco
+- dco.gemspec
+- gemfiles/master.gemfile
+- gemfiles/release.gemfile
+- lib/dco.rb
+- lib/dco/cli.rb
+- lib/dco/version.rb
+- spec/baseline_spec.rb
+- spec/check_spec.rb
+- spec/disable_spec.rb
+- spec/enable_spec.rb
+- spec/process_commit_message_spec.rb
+- spec/sign_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/coderanger/dco
+licenses:
+- Apache-2.0
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.4
+signing_key: 
+specification_version: 4
+summary: A command line tool to help manage Developer Certificate of Origin projects.
+test_files:
+- spec/baseline_spec.rb
+- spec/check_spec.rb
+- spec/disable_spec.rb
+- spec/enable_spec.rb
+- spec/process_commit_message_spec.rb
+- spec/sign_spec.rb
+- spec/spec_helper.rb