ruby_git_hooks 0.0.31

data/test/copyright_check_test.rb

@@ -0,0 +1,162 @@
+# Copyright (C) 2013 OL2, Inc. See LICENSE.txt for details.
+
+require "test_helper"
+
+require "minitest/autorun"
+require "pony"
+
+class RealCopyrightCheckHookTest < HookTestCase
+  REPOS_DIR = File.expand_path File.join(File.dirname(__FILE__), "repos")
+  FAKE_MAILER = File.join(File.dirname(__FILE__), "fake_mailer")
+  MAILER_FILE = File.join(File.dirname(__FILE__), "mail_params")
+  TEST_HOOK_BASIC = <<TEST
+#{RubyGitHooks.shebang}
+require "ruby_git_hooks/copyright_check"
+
+RubyGitHooks.register CopyrightCheckHook.new("domain" => "example.com",
+  "from" => "Copyright Enforcement <noreply@example.com>",
+  "via" => :sendmail,
+  "via_options" => {
+    :location => #{FAKE_MAILER.inspect},
+    :arguments => '#{MAILER_FILE.inspect}'
+  }
+)
+
+RubyGitHooks.run
+TEST
+
+  TEST_HOOK_COMPANY = <<TEST
+#{RubyGitHooks.shebang}
+require "ruby_git_hooks/copyright_check"
+
+RubyGitHooks.register CopyrightCheckHook.new("domain" => "example.com",
+  "from" => "Copyright Enforcement <noreply@example.com>",
+  "company_check" => /YoYoDyne (Industries)?/i,
+  "via" => :sendmail,
+  "via_options" => {
+    :location => #{FAKE_MAILER.inspect},
+    :arguments => '#{MAILER_FILE.inspect}'
+  }
+)
+
+RubyGitHooks.run
+TEST
+
+  TEST_HOOK_NO_SEND = <<TEST
+#{RubyGitHooks.shebang}
+require "ruby_git_hooks/copyright_check"
+
+RubyGitHooks.run CopyrightCheckHook.new("no_send" => true)
+TEST
+
+  TEST_HOOK_EXCLUDE = <<TEST
+#{RubyGitHooks.shebang}
+require "ruby_git_hooks/copyright_check"
+
+RubyGitHooks.register CopyrightCheckHook.new("domain" => "example.com",
+  "from" => "Copyright Enforcement <noreply@example.com>",
+  "via" => :sendmail,
+  "via_options" => {
+    :location => #{FAKE_MAILER.inspect},
+    :arguments => '#{MAILER_FILE.inspect}'
+  },
+  "exclude_files" => ["schema.rb"]
+)
+
+RubyGitHooks.run
+TEST
+
+  def setup
+    # Empty out the test repos dir
+    Hook.shell! "rm -rf #{File.join(REPOS_DIR, "*")}"
+
+    # Remove test mail file
+    Hook.shell! "rm -f #{MAILER_FILE}"
+    raise "Couldn't delete #{MAILER_FILE}!" if File.exist? MAILER_FILE
+
+    # Create local parent and child repos with a single shared commit
+    Dir.chdir REPOS_DIR
+
+    new_bare_repo
+    clone_repo
+    new_commit "child_repo", "README"
+    git_push
+  end
+
+  def test_copyright_post_commit
+    add_hook("child_repo", "post-commit", TEST_HOOK_BASIC)
+
+    new_commit("child_repo", "file_w_no_copy_notice.rb", <<FILE_CONTENTS)
+# No copyright notice!
+FILE_CONTENTS
+
+    mail_out = File.read MAILER_FILE
+
+    # Should get email with the most recent commit about
+    # file_w_no_copy_notice.rb, which has no copyright notice.
+    assert mail_out.include?(last_commit_sha[0..6]),
+      "Mail message must include latest SHA!"
+    assert mail_out.include?("file_w_no_copy_notice.rb"),
+      "Mail message must mention file_w_no_copy_notice.rb!"
+  end
+
+  def test_copyright_no_send_option
+    add_hook("child_repo", "post-commit", TEST_HOOK_NO_SEND)
+
+    new_commit("child_repo", "file_w_no_copy_notice_but_nosend.rb", <<FILE_CONTENTS)
+# No copyright notice!
+FILE_CONTENTS
+
+    assert !File.exist?(MAILER_FILE),
+      "Copyright test must not send email if 'no_send' is set!"
+  end
+
+  def test_copyright_basic_correct
+    add_hook("child_repo", "post-commit", TEST_HOOK_BASIC)
+
+    new_commit("child_repo", "correct_file.rb", <<FILE_CONTENTS)
+# Copyright (C) 1941-2013 YoyoDyne, Inc.  All Rights Reserved.
+FILE_CONTENTS
+
+    assert !File.exist?(MAILER_FILE), "Copyright test must not send email!"
+  end
+
+  def test_copyright_company_correct
+    add_hook("child_repo", "post-commit", TEST_HOOK_COMPANY)
+
+    new_commit("child_repo", "correct_file.rb", <<FILE_CONTENTS)
+# Copyright (C) 1941-2013 YoyoDyne Industries  All Rights Reserved.
+FILE_CONTENTS
+
+    assert !File.exist?(MAILER_FILE), "Copyright test must not send email!"
+  end
+
+  def test_copyright_company_incorrect
+    add_hook("child_repo", "post-commit", TEST_HOOK_COMPANY)
+
+    new_commit("child_repo", "correct_file.rb", <<FILE_CONTENTS)
+# Copyright (C) 1941-2013 YoyoWrong  All Rights Reserved.
+FILE_CONTENTS
+
+    assert File.exist?(MAILER_FILE), "Must email about wrong company name!"
+  end
+
+  def test_copyright_no_first_year
+    add_hook("child_repo", "post-commit", TEST_HOOK_BASIC)
+
+    new_commit("child_repo", "correct_file_single_year.rb", <<FILE_CONTENTS)
+# Copyright (C) 2013 YoyoDyne, Inc.  All Rights Reserved.
+FILE_CONTENTS
+
+    assert !File.exist?(MAILER_FILE), "Copyright test must not send email!"
+  end
+
+  def test_copyright_exclude_files
+    add_hook("child_repo", "post-commit", TEST_HOOK_EXCLUDE)
+    new_commit("child_repo", "schema.rb", <<FILE_CONTENTS)
+# NO copyright but I'm an excluded file.
+FILE_CONTENTS
+    assert !File.exist?(MAILER_FILE), "Copyright test must not send email!"
+  end
+
+end

data/test/fake_curl

@@ -0,0 +1,12 @@
+#!/bin/bash
+
+echo $*
+
+if [[ "$*" =~ GOOD-[0-9]{1,6} ]] ; then
+  echo "HTTP/1.1 200 OK"
+  exit 0
+fi
+
+echo "HTTP/1.1 404 Not Found"
+exit 0
+

data/test/fake_mailer

@@ -0,0 +1,5 @@
+#!/bin/bash
+
+echo $* > $1
+echo ----- >> $1
+cat /dev/stdin >> $1

data/test/jira_add_comment_test.rb

@@ -0,0 +1,151 @@
+# Copyright (C) 2013 OL2, Inc. See LICENSE.txt for details.
+
+require "test_helper"
+require "ruby_git_hooks/jira_add_comment"
+
+require "minitest/autorun"
+require "rest-client"
+
+class JiraCommentAddHookTest < HookTestCase
+  REPOS_DIR = File.expand_path File.join(File.dirname(__FILE__), "repos")
+
+  def setup
+    # NOTE- we can't just register a hook and do the commit and push
+    # for these tests because we need to mock the calls to
+    # RestClient to access Jira and the RubyGitHooks run in a separate process
+    # so the mocking won't work.
+
+    # Still create the repos and do the commits in order to get valid commit IDs
+    # for when we do the check directly
+
+    # Empty out the test repos dir
+    Hook.shell! "rm -rf #{File.join(REPOS_DIR, "*")}"
+    # Create local parent and child repos with a single shared commit
+    Dir.chdir REPOS_DIR
+
+    new_bare_repo
+    clone_repo
+    new_commit "child_repo", "README"
+    git_push
+    # add_hook("parent_repo.git", "post-receive", TEST_HOOK)   # can't do this
+    @hook = JiraCommentAddHook.new "host" => "jira.example.com",
+                                       "username" => "user", "password" => "password"
+  end
+
+  def fake_hook_check(msg = "Commit message")
+    new_commit("child_repo", "file.txt","Contents",  msg)
+    stub(@hook).commit_message { msg }
+    sha = last_commit_sha("child_repo")
+    stub(@hook).commits{[sha]}
+    Dir.chdir("child_repo") do
+      @hook.check
+    end
+  end
+
+  def test_no_reference_to_jira
+
+    dont_allow(JiraCommentAddHook).get_comment_content    # check that no comment text is prepared
+                                                          # because there are no tickets
+    fake_hook_check("No reference to Jira")
+    # will raise error if get_comment_content is called
+  end
+
+  def test_malformed_reference
+    dont_allow(JiraCommentAddHook).get_comment_content   # check that no comment text is prepared
+                                                         # because there are no tickets
+    fake_hook_check( "Incorrect reference to JiraJIRA-123" )
+    # will raise error if get_comment_content is called
+  end
+
+
+  def test_bad_reference
+    dont_allow(JiraCommentAddHook).add_comment   # check that no comments are added
+                                                         # because there are no valid tickets
+    mock(RestClient).get("https://user:password@jira.example.com/rest/api/latest/issue/BAD-234") do
+      exc = RestClient::Exception.new
+      mock(exc).http_code.at_least(1) { 404 }
+      raise exc
+    end
+
+    fake_hook_check("Message with BAD-234 reference to Jira" )
+
+    # will raise error if add_comment is called
+
+  end
+
+
+  def test_good_reference
+    mock(RestClient).get("https://user:password@jira.example.com/rest/api/latest/issue/GOOD-234") { <<JSON }
+{ "fields": { "status": { "name": "Open" } } }
+JSON
+
+    mock(RestClient).post.with_any_args {<<JSON }      # more complicated to check the args, just be sure it's called.
+{ "fields": { "status": { "name": "Open" } } }
+JSON
+
+    fake_hook_check("Message with GOOD-234 reference to Jira" )
+
+    # as long as the mocked RestClient calls happen, we succeeded
+  end
+
+
+  def test_multiple_references_with_good
+    mock(RestClient).get("https://user:password@jira.example.com/rest/api/latest/issue/GOOD-234") { <<JSON }
+{ "fields": { "status": { "name": "Open" } } }
+JSON
+    mock(RestClient).get("https://user:password@jira.example.com/rest/api/latest/issue/BAD-456") do
+      exc = RestClient::Exception.new
+      mock(exc).http_code.at_least(1) { 404 }
+      raise exc
+    end
+    mock(RestClient).get("https://user:password@jira.example.com/rest/api/latest/issue/NOT-123") do
+      exc = RestClient::Exception.new
+      mock(exc).http_code.at_least(1) { 404 }
+      raise exc
+    end
+    mock(RestClient).get("https://user:password@jira.example.com/rest/api/latest/issue/CLOSE-123") { <<JSON }
+{ "fields": { "status": { "name": "Closed" } } }
+JSON
+
+mock(RestClient).post.with_any_args {<<JSON }    # more complicated to check the args, just be sure it's called.
+  { "fields": { "status": { "name": "Open" } } }
+JSON
+
+    fake_hook_check("Message with CLOSE-123 BAD-456 GOOD-234 NOT-123 reference to Jira" )
+
+
+  end
+
+  def test_multiple_references_none_good
+    dont_allow(JiraCommentAddHook).add_comment   # check that no comments are added
+                                                 # because there are no valid tickets
+    mock(RestClient).get("https://user:password@jira.example.com/rest/api/latest/issue/BAD-456") do
+      exc = RestClient::Exception.new
+      mock(exc).http_code.at_least(1) { 404 }
+      raise exc
+    end
+    mock(RestClient).get("https://user:password@jira.example.com/rest/api/latest/issue/CLOSE-123") { <<JSON }
+{ "fields": { "status": { "name": "Closed" } } }
+JSON
+    fake_hook_check("Message with CLOSE-123 BAD-456 reference to Jira" )
+  end
+
+
+  def test_closed_ok_when_not_checking
+    @hook = JiraCommentAddHook.new "check_status" => false, "host" => "jira.example.com",
+                                   "username" => "user", "password" => "password"
+
+    mock(RestClient).get("https://user:password@jira.example.com/rest/api/latest/issue/CLOSE-123") { <<JSON }
+{ "fields": { "status": { "name": "Closed" } } }
+JSON
+    mock(RestClient).post.with_any_args {<<JSON }    # more complicated to check the args, just be sure it's called.
+  { "fields": { "status": { "name": "Open" } } }
+JSON
+
+    fake_hook_check("Message with CLOSE-123 don't check if closed reference to Jira" )
+
+
+  end
+
+
+end

data/test/jira_ref_check_test.rb

@@ -0,0 +1,37 @@
+# Copyright (C) 2013 OL2, Inc. See LICENSE.txt for details.
+
+require "test_helper"
+require "ruby_git_hooks/jira_ref_check"
+
+require "minitest/autorun"
+
+class JiraReferenceCheckHookTest < HookTestCase
+  def setup
+    @hook = JiraReferenceCheckHook.new
+  end
+
+  def test_no_reference_to_jira
+    mock(@hook).commit_message.at_least(1) { "No reference to Jira" }
+
+    assert_equal false, @hook.check
+  end
+
+  def test_malformed_reference
+    mock(@hook).commit_message.at_least(1) { "Incorrect reference to JiraJIRA-123" }
+
+    assert_equal false, @hook.check
+  end
+
+  def test_good_reference
+    mock(@hook).commit_message.at_least(1) { "Message with GOOD-234 reference to Jira" }
+
+    assert_equal true, @hook.check
+  end
+
+  def test_multiple_references_with_good
+    mock(@hook).commit_message.at_least(1) { "Message with CLOSE-123 BAD-456 GOOD-234 NOT-123 reference to Jira" }
+    assert_equal true, @hook.check
+
+  end
+  
+end

data/test/max_file_size_hook_test.rb

@@ -0,0 +1,52 @@
+# Copyright (C) 2013 OL2, Inc. See LICENSE.txt for details.
+
+require "test_helper"
+
+require "minitest/autorun"
+
+class MaxFileSizeHookTest < HookTestCase
+  REPOS_DIR = File.expand_path File.join(File.dirname(__FILE__), "repos")
+  MAX_SIZE = 100000
+  TEST_HOOK_BODY = <<TEST
+#{RubyGitHooks.shebang}
+require "ruby_git_hooks/max_file_size"
+
+RubyGitHooks.run MaxFileSizeHook.new(MAX_SIZE)
+TEST
+
+  def setup
+    # Empty out the test repos dir
+    Hook.shell! "rm -rf #{File.join(REPOS_DIR, "*")}"
+
+    # Create local parent and child repos with a single shared commit
+    Dir.chdir REPOS_DIR
+
+    new_bare_repo
+    clone_repo
+    new_commit "child_repo", "README"
+    git_push
+  end
+
+  def test_max_file_size_pre_receive
+    add_hook("parent_repo.git", "pre-receive", TEST_HOOK_BODY)
+    filename = "#{REPOS_DIR}/child_repo/BigFile.txt"   
+       
+   File.open(filename, "w") do |f|
+      alphanum =  [('a'..'z'),('A'..'Z'),('0'..'9')].map{|i| i.to_a}.flatten
+      string  =  (0...MAX_SIZE*2).map{ alphanum[rand(alphanum.length)] }.join
+      f.write(string)
+    end
+    new_commit "child_repo", "BigFile.txt", nil
+
+    # Should reject w/ pre-commit hook
+    assert_raises RuntimeError do
+      git_push
+    end
+  end
+  
+
+  #def test_case_clash_pre_commit
+  #  add_hook("parent_repo.git", "pre-receive", TEST_HOOK_BODY)
+  #end
+
+end

data/test/multi_hook_test.rb

@@ -0,0 +1,77 @@
+# Copyright (C) 2013 OL2, Inc. See LICENSE.txt for details.
+
+require "test_helper"
+
+require "minitest/autorun"
+
+class CopyrightCheckHookTest < HookTestCase
+  REPOS_DIR = File.expand_path File.join(File.dirname(__FILE__), "repos")
+  TEST_HOOK_MULTI_REG = <<TEST
+#{RubyGitHooks.shebang}
+require "ruby_git_hooks/ruby_debug"
+require "ruby_git_hooks/copyright_check"
+
+RubyGitHooks.register RubyDebugHook.new
+RubyGitHooks.register CopyrightCheckHook.new("no_send" => true)
+
+RubyGitHooks.run
+TEST
+
+  TEST_HOOK_MULTI_RUN = <<TEST
+#{RubyGitHooks.shebang}
+require "ruby_git_hooks/ruby_debug"
+require "ruby_git_hooks/copyright_check"
+
+RubyGitHooks.run RubyDebugHook.new,
+                 CopyrightCheckHook.new("no_send" => true)
+TEST
+
+  def setup
+    # Empty out the test repos dir
+    Hook.shell! "rm -rf #{File.join(REPOS_DIR, "*")}"
+
+    # Create local parent and child repos with a single shared commit
+    Dir.chdir REPOS_DIR
+
+    new_bare_repo
+    clone_repo
+    new_commit "child_repo", "README"
+    git_push
+  end
+
+  def test_multi_reg_pre_commit
+    add_hook("child_repo", "pre-commit", TEST_HOOK_MULTI_REG)
+
+    last_sha = last_commit_sha
+
+    new_commit("child_repo", "myfile.rb", <<FILE_CONTENTS)
+# Copyright (C) 2013 YoyoDyne, Inc.  All Rights Reserved.
+# No copyright notice, no ruby-debug.  Should be fine.
+FILE_CONTENTS
+
+    assert last_sha != last_commit_sha,
+      "Multiple pre-commit should accept legal commit."
+    last_sha = last_commit_sha  # update
+
+    assert_raises RuntimeError do
+      new_commit("child_repo", "myfile.rb", <<FILE_CONTENTS)
+# No copyright notice, but no ruby-debug
+FILE_CONTENTS
+    end
+
+    assert_equal last_sha, last_commit_sha,
+      "Multiple pre-commit should refuse illegal commit (1)."
+
+    assert_raises RuntimeError do
+      new_commit("child_repo", "myfile.rb", <<FILE_CONTENTS)
+# Includes a copyright notice, but has ruby-debug
+# Copyright (C) 2013 YoyoDyne, Inc.  All Rights Reserved.
+require 'ruby-debug'
+FILE_CONTENTS
+    end
+
+    assert_equal last_sha, last_commit_sha,
+      "Multiple pre-commit should refuse illegal commit (2)."
+
+  end
+end

data/test/non_ascii_hook_test.rb

@@ -0,0 +1,47 @@
+# -*- coding: utf-8 -*-
+# Copyright (C) 2013 OL2, Inc. See LICENSE.txt for details.
+
+require "test_helper"
+
+require "minitest/autorun"
+
+class NonAsciiHookTest < HookTestCase
+  REPOS_DIR = File.expand_path File.join(File.dirname(__FILE__), "repos")
+  FAKE_CURL = File.expand_path File.join(File.dirname(__FILE__), "fake_curl")
+  TEST_HOOK_BODY = <<TEST
+#{RubyGitHooks.shebang}
+require "ruby_git_hooks/non_ascii"
+
+RubyGitHooks.run NonAsciiCharactersCheckHook.new
+TEST
+
+  def setup
+    # Empty out the test repos dir
+    Hook.shell! "rm -rf #{File.join(REPOS_DIR, "*")}"
+
+    # Create local parent and child repos with a single shared commit
+    Dir.chdir REPOS_DIR
+
+    new_bare_repo
+    clone_repo
+    new_commit "child_repo", "README"
+    git_push
+  end
+
+  def test_non_ascii_commit_msg
+    add_hook("child_repo", "commit-msg", TEST_HOOK_BODY)
+
+    assert_raises RuntimeError do
+      new_commit "child_repo", "test1", "Contents", "Hello this a mixed string © that I made.\nнельзя писать в коммит сообщение по русски"
+    end
+
+    # This should succeed
+    new_commit "child_repo", "test2", "GoodContents", "Nice and warm non-ascii message"
+
+  end
+
+  #def test_case_clash_pre_commit
+  #  add_hook("parent_repo.git", "pre-receive", TEST_HOOK_BODY)
+  #end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,17 @@
+# Copyright (C) 2013 OL2, Inc. See LICENSE.txt for details.
+
+# Test local copy first
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), "..", "lib")
+
+require "minitest/pride"
+require "rr"
+
+require "ruby_git_hooks"
+require "ruby_git_hooks/git_ops"
+
+class HookTestCase < MiniTest::Unit::TestCase
+  Hook = RubyGitHooks::Hook
+  include RubyGitHooks::GitOps
+
+  include RR::Adapters::MiniTest
+end

data/test/watermark_test.rb

@@ -0,0 +1,39 @@
+# coding: utf-8
+require "test_helper"
+
+require "minitest/autorun"
+
+class AddWatermarkHookTest < HookTestCase
+  REPOS_DIR = File.expand_path File.join(File.dirname(__FILE__), "repos")
+  FAKE_CURL = File.expand_path File.join(File.dirname(__FILE__), "fake_curl")
+  TEST_HOOK_BODY = <<TEST
+#{RubyGitHooks.shebang}
+require "ruby_git_hooks/watermark"
+
+RubyGitHooks.run AddWatermarkCommitHook.new("WATERMARK")
+TEST
+
+  def setup
+    # Empty out the test repos dir
+    Hook.shell! "rm -rf #{File.join(REPOS_DIR, "*")}"
+
+    # Create local parent and child repos with a single shared commit
+    Dir.chdir REPOS_DIR
+
+    new_bare_repo
+    clone_repo
+    new_commit "child_repo", "README"
+    git_push
+  end
+
+  def test_commit_has_watermark
+    add_hook("child_repo", "commit-msg", TEST_HOOK_BODY)
+
+    # This should succeed
+    new_commit "child_repo", "test2", "GoodContents", "Commit message"
+    msg = last_commit_message ("child_repo")
+    assert msg =~/WATERMARK/
+  end
+
+
+end