dco 1.0.0

data/lib/dco/version.rb

@@ -0,0 +1,21 @@
+#
+# 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.
+#
+
+
+module Dco
+  # dco gem version.
+  VERSION = '1.0.0'
+end

data/spec/baseline_spec.rb

@@ -0,0 +1,34 @@
+#
+# 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 'baseline' do
+  # The most recent commit object.
+  subject { repo.log.first }
+
+  # Check that the test harness is working.
+  git_init
+  file 'testing'
+  before do
+    command 'git add testing'
+    command 'git commit -m "harness test"'
+  end
+
+  its(:message) { is_expected.to eq 'harness test' }
+  its('author.name') { is_expected.to eq 'Alan Smithee' }
+  its('author.email') { is_expected.to eq 'asmithee@example.com' }
+end

data/spec/check_spec.rb

@@ -0,0 +1,172 @@
+#
+# 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 check' do
+  # Create a branch structure for all tests.
+  git_init
+  file 'testing', 'one'
+  before do
+    cmds = [
+      'git add testing',
+      'git commit -s -m "first commit"',
+      'echo two > testing',
+      'git commit -s -a -m "second commit"',
+      'git checkout -b mybranch',
+    ]
+    command cmds.join(' && ')
+  end
+  dco_command 'check mybranch'
+
+  context 'with no commits in the branch' do
+    it do
+      expect(subject.exitstatus).to eq 0
+      expect(subject.stdout).to eq "All commits are signed off\n"
+    end
+  end # /context with no commits in the branch
+
+  context 'with one signed commit in the branch' do
+    before do
+      command 'echo three > testing && git commit -s -a -m "first branch commit"'
+    end
+
+    it do
+      expect(subject.exitstatus).to eq 0
+      expect(subject.stdout).to eq "All commits are signed off\n"
+    end
+  end # /context with one signed commit in the branch
+
+  context 'with one unsigned commit in the branch' do
+    before do
+      command 'echo three > testing && git commit -a -m "first branch commit" && echo four > testing && git commit -s -a -m "second branch commit"'
+    end
+
+    it do
+      expect(subject.exitstatus).to eq 1
+      expect(subject.stdout).to match /^N \h{7} Alan Smithee <asmithee@example.com> first branch commit$/
+    end
+  end # /context with one unsigned commit in the branch
+
+  context 'with two signed commits in the branch' do
+    before do
+      command 'echo three > testing && git commit -s -a -m "first branch commit" && echo four > testing && git commit -s -a -m "second branch commit"'
+    end
+
+    it do
+      expect(subject.exitstatus).to eq 0
+      expect(subject.stdout).to eq "All commits are signed off\n"
+    end
+  end # /context with two signed commits in the branch
+
+  context 'with an implicit branch' do
+    before do
+      command 'echo three > testing && git commit -a -m "first branch commit" && echo four > testing && git commit -s -a -m "second branch commit"'
+    end
+    dco_command 'check'
+
+    it do
+      expect(subject.exitstatus).to eq 1
+      expect(subject.stdout).to match /^N \h{7} Alan Smithee <asmithee@example.com> first branch commit$/
+    end
+  end # /context with an implicit branch
+
+  context 'with a branch that has a merge commit' do
+    before do
+      command('echo three > other && ' \
+        'git add other && ' \
+        'git commit -s -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
+
+    it do
+      expect(subject.exitstatus).to eq 1
+      expect(subject.stdout).to match /^N \h{7} Alan Smithee <asmithee@example.com> second branch commit$/
+      expect(subject.stdout).to_not match /^N \h{7} Alan Smithee <asmithee@example.com> third commit$/
+      # TODO What should the check behavior on merge commits be? https://github.com/coderanger/dco/issues/1
+    end
+  end # /context with a branch that has a merge commit
+
+  context 'with --quiet' do
+    dco_command 'check --quiet'
+
+    context 'with no bad commits' do
+      before { command 'echo three > testing && git commit -s -a -m "first branch commit"' }
+
+      it do
+        expect(subject.exitstatus).to eq 0
+        expect(subject.stdout).to eq ''
+        expect(subject.stderr).to eq ''
+      end
+    end # /context with no bad commits
+
+    context 'with bad commits' do
+      before { command 'echo three > testing && git commit -a -m "first branch commit"' }
+
+      it do
+        expect(subject.exitstatus).to eq 1
+        expect(subject.stdout).to eq ''
+        expect(subject.stderr).to eq ''
+      end
+    end # /context with bad commits
+  end # /context with --quiet
+
+  context 'with the master branch' do
+    before do
+      command('echo three > other && ' \
+        'git add other && ' \
+        'git commit -s -a -m "first branch commit" && ' \
+        'git checkout master && ' \
+        'echo three > testing && ' \
+        'git commit -a -m "third commit"')
+    end
+    dco_command 'check master'
+
+    it do
+      expect(subject.exitstatus).to eq 1
+      expect(subject.stdout).to match /^N \h{7} Alan Smithee <asmithee@example.com> third commit$/
+      expect(subject.stdout).to_not match /^N \h{7} Alan Smithee <asmithee@example.com> first branch commit$/
+    end
+  end # /context with the master branch
+
+  context 'with an author mismatch' do
+    file 'msg', "first branch commit\n\nSigned-off-by: Commiter McCommiterface <other@example.com>\n"
+    before do
+      command 'echo three > testing && git commit -a -F msg'
+    end
+
+    it do
+      expect(subject.exitstatus).to eq 1
+      expect(subject.stdout).to match /^M \h{7} Alan Smithee <asmithee@example.com> first branch commit$/
+    end
+
+    context 'with --allow-author-mismatch' do
+      dco_command 'check --allow-author-mismatch mybranch'
+
+    it do
+      expect(subject.exitstatus).to eq 0
+      expect(subject.stdout).to eq "All commits are signed off\n"
+    end
+
+    end # /context with --allow-author-mismatch
+  end # /context with an author mismatch
+end

data/spec/disable_spec.rb

@@ -0,0 +1,61 @@
+#
+# 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 disable' do
+  # The most recent commit object.
+  subject { repo.log.first }
+
+  context 'with a normal commit' do
+    git_init
+    file 'testing'
+    before do
+      dco_command 'enable -y'
+      dco_command 'disable'
+      command 'git add testing'
+      command 'git commit -m "test commit"'
+    end
+
+    its(:message) { is_expected.to eq "test commit" }
+  end # /context with a normal commit
+
+  context 'with disable called twice' do
+    git_init
+    file 'testing'
+    before do
+      dco_command 'enable -y'
+      dco_command 'disable'
+      dco_command 'disable'
+      command 'git add testing'
+      command 'git commit -m "test commit"'
+    end
+
+    its(:message) { is_expected.to eq "test commit" }
+  end # /context with disable called twice
+
+  context 'with an external commit-msg script' do
+    git_init
+    file '.git/hooks/commit-msg', 'SOMETHING ELSE'
+    dco_command 'disable'
+
+    it do
+      expect(subject.exitstatus).to eq 1
+      expect(subject.stdout).to eq ''
+      expect(subject.stderr).to match /^commit-msg hook is external, not removing$/
+    end
+  end # /context with an existing commit-msg script
+end

data/spec/enable_spec.rb

@@ -0,0 +1,104 @@
+#
+# 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 enable' do
+  # The most recent commit object.
+  subject { repo.log.first }
+
+  context 'without a git repository' do
+    dco_command 'enable -y'
+
+    it do
+      expect(subject.exitstatus).to eq 1
+      expect(subject.stdout).to eq ''
+      expect(subject.stderr).to match /does not appear to be a git repository$/
+    end
+  end # /context without a git repository
+
+  context 'with an unwritable git repository' do
+    git_init
+    before { File.chmod(00544, File.join(temp_path, '.git')) }
+    dco_command 'enable -y'
+    after { File.chmod(00744, File.join(temp_path, '.git')) }
+
+    it do
+      expect(subject.exitstatus).to eq 1
+      expect(subject.stdout).to eq ''
+      expect(subject.stderr).to match /^Git repository at.*? is read-only$/
+    end
+  end # /context with an unwritable git repository
+
+  context 'with an existing commit-msg script' do
+    git_init
+    file '.git/hooks/commit-msg', 'SOMETHING ELSE'
+    dco_command 'enable -y'
+
+    it do
+      expect(subject.exitstatus).to eq 1
+      expect(subject.stdout).to eq ''
+      expect(subject.stderr).to match /^commit-msg hook already exists, not overwriting$/
+    end
+  end # /context with an existing commit-msg script
+
+  context 'with a normal commit' do
+    git_init
+    file 'testing'
+    before do
+      dco_command 'enable -y'
+      command 'git add testing'
+      command 'git commit -m "test commit"'
+    end
+
+    its(:message) { is_expected.to eq "test commit\n\nSigned-off-by: Alan Smithee <asmithee@example.com>" }
+  end # /context with a normal commit
+
+  context 'with a signed-off commit' do
+    git_init
+    file 'testing'
+    before do
+      dco_command 'enable -y'
+      command 'git add testing'
+      command 'git commit -s -m "test commit"'
+    end
+
+    its(:message) { is_expected.to eq "test commit\n\nSigned-off-by: Alan Smithee <asmithee@example.com>" }
+  end # /context with a signed-off commit
+
+  context 'with enable called twice' do
+    git_init
+    file 'testing'
+    before do
+      dco_command 'enable -y'
+      dco_command 'enable -y'
+      command 'git add testing'
+      command 'git commit -m "test commit"'
+    end
+
+    its(:message) { is_expected.to eq "test commit\n\nSigned-off-by: Alan Smithee <asmithee@example.com>" }
+  end # /context with enable called twice
+
+  context 'without -y' do
+    git_init
+    dco_command 'enable'
+
+    it do
+      expect(subject.exitstatus).to eq 1
+      expect(subject.stderr).to eq "Not enabling auto-sign-off without approval\n"
+    end
+  end # /context without -y
+end

data/spec/process_commit_message_spec.rb

@@ -0,0 +1,132 @@
+#
+# 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 process_commit_message' do
+  around do |ex|
+    begin
+      ENV['GIT_COMMIT'] = 'abcd123'
+      ENV['GIT_AUTHOR_NAME'] = 'Alan Smithee'
+      ENV['GIT_AUTHOR_EMAIL'] = 'asmithee@example.com'
+      ex.run
+    ensure
+      ENV.delete('GIT_COMMIT')
+      ENV.delete('GIT_AUTHOR_NAME')
+      ENV.delete('GIT_AUTHOR_EMAIL')
+    end
+  end
+
+  context 'hook mode' do
+    dco_command 'process_commit_message msg'
+
+    RSpec.shared_examples 'process_commit_message hook mode' do |input, output|
+      file 'msg', input
+
+      it do
+        expect(subject.exitstatus).to eq 0
+        expect(subject.stdout).to eq ''
+        expect(subject.stderr).to eq ''
+        expect(IO.read(File.join(temp_path, 'msg'))).to eq output
+      end
+    end
+
+    context 'with a normal commit' do
+      it_behaves_like 'process_commit_message hook mode', "test commit\n", "test commit\n\nSigned-off-by: Alan Smithee <asmithee@example.com>\n"
+    end # /context with a normal commit
+
+    context 'with no trailing newline' do
+      it_behaves_like 'process_commit_message hook mode', "test commit", "test commit\n\nSigned-off-by: Alan Smithee <asmithee@example.com>\n"
+    end # /context with no trailing newline
+
+    context 'with existing sign-off' do
+      it_behaves_like 'process_commit_message hook mode', "test commit\n\nSigned-off-by: Someone Else <other@example.com>\n", "test commit\n\nSigned-off-by: Someone Else <other@example.com>\n"
+    end # /context with existing sign-off
+
+    context 'with two existing sign-offs' do
+      it_behaves_like 'process_commit_message hook mode', "test commit\n\nSigned-off-by: Alan Smithee <asmithee@example.com>\nSigned-off-by: Someone Else <other@example.com>\n", "test commit\n\nSigned-off-by: Alan Smithee <asmithee@example.com>\nSigned-off-by: Someone Else <other@example.com>\n"
+    end # /context with two existing sign-offs
+  end # /context hook mode
+
+  context 'filter mode' do
+    let(:input) { '' }
+    let(:git_ident) { {} }
+    let(:stdin) { double('STDIN', read: input) }
+    before do
+      # Use a let variable instead of calling git_init again in a later before
+      # block because we need to all command running before the STDIN stub.
+      git_init git_ident
+      stub_const('STDIN', stdin)
+    end
+
+    context 'with a normal commit' do
+      let(:input) { "test commit\n" }
+      dco_command 'process_commit_message'
+
+      it do
+        expect(subject.exitstatus).to eq 0
+        expect(subject.stdout).to eq "test commit\n\nSigned-off-by: Alan Smithee <asmithee@example.com>\n"
+        expect(subject.stderr).to eq ''
+      end
+    end # /context with a normal commit
+
+    context 'with existing sign-off' do
+      let(:input) { "test commit\n\nSigned-off-by: Someone Else <other@example.com>\n" }
+      dco_command 'process_commit_message'
+
+      it do
+        expect(subject.exitstatus).to eq 0
+        expect(subject.stdout).to eq "test commit\n\nSigned-off-by: Someone Else <other@example.com>\n"
+        expect(subject.stderr).to eq ''
+      end
+    end # /context with existing sign-off
+
+    context 'with --behalf' do
+      let(:input) { "test commit\n" }
+      let(:git_ident) { {name: 'Someone Else', email: 'other@example.com'} }
+      dco_command 'process_commit_message --behalf http://example.com/'
+
+      it do
+        expect(subject.exitstatus).to eq 0
+        expect(subject.stdout).to eq "test commit\n\nSigned-off-by: Alan Smithee <asmithee@example.com>\nSign-off-executed-by: Someone Else <other@example.com>\nApproved-at: http://example.com/\n"
+        expect(subject.stderr).to eq ''
+      end
+    end # /context with --behalf
+
+    context 'with someone elses commit' do
+      let(:input) { "test commit\n" }
+      let(:git_ident) { {name: 'Someone Else', email: 'other@example.com'} }
+      dco_command 'process_commit_message'
+
+      it do
+        expect(subject.exitstatus).to eq 1
+        expect(subject.stdout).to eq "test commit\n"
+        expect(subject.stderr).to eq "Author mismatch on commit abcd123: asmithee@example.com vs other@example.com\n"
+      end
+    end # /context with someone elses commit
+
+    context 'with --repo' do
+      let(:input) { "test commit\n" }
+      subject { dco_command "process_commit_message --repo '#{temp_path}'" }
+
+      it do
+        expect(subject.exitstatus).to eq 0
+        expect(subject.stdout).to eq "test commit\n\nSigned-off-by: Alan Smithee <asmithee@example.com>\n"
+        expect(subject.stderr).to eq ''
+      end
+    end # /context with --repo
+  end # /context filter mode
+end