danger-samsao 0.2.0 → 0.3.0

data/lib/samsao/actions.rb

@@ -1,52 +1,166 @@
 module Samsao
   # Actions mixin module
   module Actions
-    # Fails when git branching model is not respected for PR branch name.
+    # Check if the git branching model is not respected for PR branch name.
     #
+    # @param  [Symbol] level (Default: :fail)
+    #         The report level (:fail, :warn, :message) if the check fails [report](#report)
     # @return [void]
-    def fail_when_wrong_branching_model
+    #
+    def check_wrong_branching_model(level = :fail)
       message = 'Your branch should be prefixed with feature/, fix/, bugfix/, hotfix/, release/ or support/!'
 
-      fail message unless respects_branching_model
+      report(level, message) unless respects_branching_model
     end
 
-    # Fails when a feature branch have than one commit
+    # Check if a feature branch have more than one commit.
     #
+    # @param  [Symbol] level (Default: :fail)
+    #         The report level (:fail, :warn, :message) if the check fails [report](#report)
     # @return [void]
-    def fail_when_non_single_commit_feature
+    #
+    def check_non_single_commit_feature(level = :fail)
       commit_count = git.commits.size
       message = "Your feature branch should have a single commit but found #{commit_count}, squash them together!"
 
-      fail message if feature_branch? && commit_count > 1
+      report(level, message) if feature_branch? && commit_count > 1
     end
 
-    # Fails when CHANGELOG is not updated on feature or fix branches
+    # Check if the CHANGELOG wasn't updated on feature or fix branches.
     #
+    # @param  [Symbol] level (Default: :fail)
+    #         The report level (:fail, :warn, :message) if the check fails [report](#report)
     # @return [void]
-    def fail_when_changelog_update_missing
+    #
+    def check_changelog_update_missing(level = :fail)
       return if trivial_change?
       return if support_branch? && config.project_type == :application
 
-      fail 'You did a change without updating CHANGELOG file!' unless changelog_modified?
+      report(level, 'You did a change without updating CHANGELOG file!') unless changelog_modified?
     end
 
-    # Fails when one or more merge commit is detected.
+    # Check if one or more merge commit is detected.
     #
+    # @param  [Symbol] level (Default: :fail)
+    #         The report level (:fail, :warn, :message) if the check fails [report](#report)
     # @return [void]
-    def fail_when_merge_commit_detected
+    #
+    def check_merge_commit_detected(level = :fail)
       message = 'Some merge commits were detected, you must use rebase to sync with base branch.'
       merge_commit_detector = /^Merge branch '#{github.branch_for_base}'/
 
-      fail message if git.commits.any? { |commit| commit.message =~ merge_commit_detector }
+      report(level, message) if git.commits.any? { |commit| commit.message =~ merge_commit_detector }
+    end
+
+    # Check for work in progress commit message in PR.
+    #
+    # @param  [Symbol] level (Default: :warn)
+    #         The report level (:fail, :warn, :message) if the check fails [report](#report)
+    # @return [void]
+    #
+    def check_work_in_progess_pr(level = :warn)
+      report(level, 'Do not merge, PR is a work in progess [WIP]!') if github.pr_title.include?('[WIP]')
+    end
+
+    # Check if a feature branch contains a single JIRA issue number matching the jira project key.
+    #
+    # @param  [Symbol] level (Default: :fail)
+    #         The report level (:fail, :warn, :message) if the check fails [report](#report)
+    # @return [void]
+    #
+    def check_feature_jira_issue_number(level = :fail)
+      return if samsao.trivial_change? || !samsao.feature_branch?
+      return report(:fail, 'Your Danger config is missing a `jira_project_key` value.') unless jira_project_key?
+
+      message = 'The PR must starts with JIRA issue number between square brackets'\
+                " (i.e. [#{config.jira_project_key}-XXX])."
+
+      report(level, message) unless contains_jira_issue_number?(github.pr_title)
+    end
+
+    # Check if all fix branch commit's message contains any JIRA issue number matching the jira project key.
+    #
+    # @param  [Symbol] level (Default: :warn)
+    #         The report level (:fail, :warn, :message) if the check fails [report](#report)
+    # @return [void]
+    #
+    def check_fix_jira_issue_number(level = :warn)
+      return if samsao.trivial_change? || !samsao.fix_branch?
+      return report(:fail, 'Your Danger config is missing a `jira_project_key` value.') unless jira_project_key?
+
+      git.commits.each do |commit|
+        check_commit_contains_jira_issue_number(commit, level)
+      end
     end
 
-    # Fails when CHANGELOG is not updated on feature or fix branches
+    # Check if it's a feature branch and if the PR body contains acceptance criteria.
     #
+    # @param  [Symbol] level (Default: :warn)
+    #         The report level (:fail, :warn, :message) if the check fails [report](#report)
     # @return [void]
-    def warn_when_work_in_progess_pr
-      message = 'Do not merge, PR is a work in progess [WIP]!'
+    #
+    def check_acceptance_criteria(level = :warn)
+      return unless samsao.feature_branch?
+
+      message = 'The PR should have the acceptance criteria in the body.'
+
+      report(level, message) if (/acceptance criteria/i =~ github.pr_body).nil?
+    end
+
+    # Check if the PR has at least one label added to it.
+    #
+    # @param  [Symbol] level (Default: :fail)
+    #         The report level (:fail, :warn, :message) if the check fails [report](#report)
+    # @return [void]
+    #
+    def check_label_pr(level = :fail)
+      message = 'The PR should have at least one label added to it.'
+
+      report(level, message) if github.pr_labels.nil? || github.pr_labels.empty?
+    end
+
+    # Send report to danger depending on the level.
+    #
+    # @param  [Symbol] level
+    #         The report level sent to Danger :
+    #           :message  > Comment a message to the table
+    #           :warn     > Declares a CI warning
+    #           :fail     > Declares a CI blocking error
+    # @param  [String] content
+    #         The message of the report sent to Danger
+    # @return [void]
+    #
+    def report(level, content)
+      case level
+      when :warn
+        warn content
+      when :fail
+        fail content
+      when :message
+        message content
+      else
+        raise "Report level '#{level}' is invalid."
+      end
+    end
+
+    private
+
+    # Check if the commit's message contains any JIRA issue number matching the jira project key.
+    #
+    # @param  [Commit] commit
+    #         The git commit to check
+    # @param  [Symbol] level (Default: :warn)
+    #         The report level (:fail, :warn, :message) if the check fails [report](#report)
+    # @return [void]
+    #
+    def check_commit_contains_jira_issue_number(commit, type)
+      commit_id = "#{shorten_sha(commit.sha)} ('#{truncate(commit.message)}')"
+      jira_project_key = config.jira_project_key
+      message = "The commit #{commit_id} should contain JIRA issue number" \
+      " between square brackets (i.e. [#{jira_project_key}-XXX]), multiple allowed" \
+      " (i.e. [#{jira_project_key}-XXX, #{jira_project_key}-YYY, #{jira_project_key}-ZZZ])"
 
-      warn message if github.pr_title.include?('[WIP]')
+      report(type, message) unless contains_jira_issue_number?(commit.message)
     end
   end
 end

data/lib/samsao/config.rb

@@ -7,6 +7,7 @@ module Danger
       @changelogs = ['CHANGELOG.md']
       @sources = []
       @project_type = :application
+      @jira_project_key = nil
     end
 
     def changelogs(*entries)
@@ -15,6 +16,12 @@ module Danger
       @changelogs = entries
     end
 
+    def jira_project_key(key = nil)
+      return @jira_project_key if key.nil?
+
+      @jira_project_key = validate_jira_project_key(key)
+    end
+
     def project_type(type = nil)
       return @project_type if type.nil?
 
@@ -29,6 +36,12 @@ module Danger
 
     private
 
+    def validate_jira_project_key(key)
+      return key unless (/^[A-Z]{1,10}$/ =~ key).nil?
+
+      raise "Jira project key '#{key}' is invalid, must be uppercase and between 1 and 10 characters"
+    end
+
     def validate_project_type(type)
       return type if valid_project_type?(type)
 

data/lib/samsao/gem_version.rb

@@ -1,3 +1,3 @@
 module Samsao
-  VERSION = '0.2.0'.freeze
+  VERSION = '0.3.0'.freeze
 end

data/lib/samsao/helpers.rb

@@ -6,52 +6,59 @@ module Samsao
     # Check if any changelog were modified. When the helper receives nothing,
     # changelogs defined by the config are used.
     #
-    # @return [Boolean] True if any changelogs were modified in this commit
+    # @return [Bool] True
+    #         If any changelogs were modified in this commit
+    #
     def changelog_modified?(*changelogs)
       changelogs = config.changelogs if changelogs.nil? || changelogs.empty?
 
       changelogs.any? { |changelog| git.modified_files.include?(changelog) }
     end
 
-    # Return true if the current PR branch is a feature branch
+    # Return true if the current PR branch is a feature branch.
+    #
+    # @return [Bool]
     #
-    # @return [void]
     def feature_branch?
       git_branch.start_with?('feature/')
     end
 
-    # Return true if the current PR branch is a bug fix branch
+    # Return true if the current PR branch is a bug fix branch.
+    #
+    # @return [Bool]
     #
-    # @return [void]
     def fix_branch?
       !(%r{^(bug|hot)?fix/} =~ git_branch).nil?
     end
 
-    # Return true if the current PR branch is a release branch
+    # Return true if the current PR branch is a release branch.
+    #
+    # @return [Bool]
     #
-    # @return [void]
     def release_branch?
       git_branch.start_with?('release/')
     end
 
-    # Return true if the current PR branch is a support branch
+    # Return true if the current PR branch is a support branch.
+    #
+    # @return [Bool]
     #
-    # @return [void]
     def support_branch?
       git_branch.start_with?('support/')
     end
 
-    # Return true if the current PR is a trivial change, i.e. if
-    # PR title contains #trivial or #typo markers.
+    # Return true if the current PR is a trivial change, i.e. if PR title contains #trivial or #typo markers.
+    #
+    # @return [Bool]
     #
-    # @return [void]
     def trivial_change?
       !(/#(trivial|typo(s)?)/ =~ github.pr_title).nil?
     end
 
     # Return true if any source files are in the git modified files list.
     #
-    # @return [void]
+    # @return [Bool]
+    #
     def has_app_changes?(*sources)
       sources = config.sources if sources.nil? || sources.empty?
 
@@ -62,6 +69,48 @@ module Samsao
       end
     end
 
+    # Return true if the config has a jira project key.
+    #
+    # @return [Bool]
+    #
+    def jira_project_key?
+      !config.jira_project_key.nil?
+    end
+
+    # Return true if PR title contains any number of JIRA issues.
+    #
+    # @return [Bool]
+    #
+    def contains_jira_issue_number?(input)
+      !(/\[#{config.jira_project_key}-\d+(,( *#{config.jira_project_key}-)? *\d+)*\]/ =~ input).nil?
+    end
+
+    # Shorten git commit's sha to seven characters.
+    #
+    # @param  [String] sha
+    #         A git commit's sha
+    # @return [String]
+    #
+    def shorten_sha(sha)
+      return sha if sha.nil?
+
+      sha[0..7]
+    end
+
+    # Truncate the string received.
+    #
+    # @param  [String] input
+    #         The string to truncate
+    # @param  [Number] max (Default: 30)
+    #         The max size of the truncated string
+    # @return [String]
+    #
+    def truncate(input, max = 30)
+      return input if input.nil? || input.length <= max
+
+      input[0..max - 1].gsub(/\s\w+\s*$/, '...')
+    end
+
     private
 
     def git_branch

data/lib/samsao/plugin.rb

@@ -18,6 +18,7 @@ module Danger
     # Enable to configure the plugin configuration object.
     #
     # @return [Array<String>] (if no block given)
+    #
     def config(&block)
       @config = Danger::SamsaoConfig.new if @config.nil?
       return @config unless block_given?

data/lib/samsao/regexp.rb

@@ -4,9 +4,11 @@ module Samsao
     # Turns a source entry input into a Regexp. Uses rules from [from_matcher](#from_matcher)
     # function and append a `^` to final regexp when the source if a pure String.
     #
-    # @param matcher The source entry to transform into a Regexp
+    # @param  [String] source
+    #         The source entry to transform into a Regexp
+    # @return [Regexp]
+    #         The source entry as a regexp
     #
-    # @return [Regexp] The source entry as a regexp
     def self.from_source(source)
       from_matcher(source, when_string_pattern_prefix_with: '^')
     end
@@ -15,11 +17,13 @@ module Samsao
     # into a Regexp and escape all special characters. If the input is already
     # a Regexp, it returns it without modification.
     #
-    # @param matcher The input matcher to transform into a Regexp
-    # @keyword when_string_pattern_prefix_with (Default: '') The prefix that should be added to
-    #               final regexp when the input matcher is a string type
+    # @param    [String] matcher
+    #           The input matcher to transform into a Regexp
+    # @keyword  [String] when_string_pattern_prefix_with (Default: '')
+    #           The prefix that should be added to final regexp when the input matcher is a string type
+    # @return   [Regexp]
+    #           The input as a regexp
     #
-    # @return [Regexp] The input as a regexp
     def self.from_matcher(matcher, when_string_pattern_prefix_with: '')
       return matcher if matcher.is_a?(::Regexp)
 

data/spec/matchers/have_message.rb

@@ -0,0 +1,25 @@
+require 'rspec/expectations'
+
+RSpec::Matchers.define :have_message do |expected|
+  match do |actual|
+    actual.status_report[:messages].any? do |message|
+      expected.is_a?(Regexp) ? message =~ matcher : message.start_with?(expected)
+    end
+  end
+
+  failure_message do |actual|
+    result = "expected that #{Danger} would have warning '#{expected}'"
+
+    messages = actual.status_report[:messages]
+    if messages.empty?
+      result += ' but there is none'
+      return result
+    end
+
+    actual.status_report[:messages].each do |message|
+      result += "\n * #{message}"
+    end
+
+    result
+  end
+end

data/spec/matchers/have_no_message.rb

@@ -0,0 +1,14 @@
+require 'rspec/expectations'
+
+RSpec::Matchers.define :have_no_message do
+  match do |actual|
+    actual.status_report[:messages].empty?
+  end
+
+  failure_message do |actual|
+    result = "expected that #{Danger} would have no message but found '#{actual.status_report[:messages].size}'"
+    actual.status_report[:messages].each do |message|
+      result += "\n * #{message}"
+    end
+  end
+end

data/spec/samsao_acceptance_criteria_spec.rb

@@ -0,0 +1,54 @@
+require File.expand_path('../spec_helper', __FILE__)
+
+module Danger
+  describe Danger::DangerSamsao do
+    describe 'with Dangerfile' do
+      before do
+        @dangerfile = testing_dangerfile
+        @plugin = @dangerfile.samsao
+        @message = 'The PR should have the acceptance criteria in the body.'
+      end
+
+      describe 'check acceptance criteria' do
+        it 'continues on fix branch' do
+          allow(@plugin).to receive(:feature_branch?).and_return(false)
+
+          @plugin.check_acceptance_criteria
+
+          expect(@dangerfile).to have_no_warning
+          expect(@dangerfile).to have_no_error
+        end
+
+        it 'warns if acceptance criteria is missing' do
+          allow(@plugin).to receive(:feature_branch?).and_return(true)
+          allow(@plugin.github).to receive(:pr_body).and_return('Bad example')
+
+          @plugin.check_acceptance_criteria
+
+          expect(@dangerfile).to have_warning(@message)
+          expect(@dangerfile).to have_no_error
+        end
+
+        it 'fails if report level specified' do
+          allow(@plugin).to receive(:feature_branch?).and_return(true)
+          allow(@plugin.github).to receive(:pr_body).and_return('Bad example')
+
+          @plugin.check_acceptance_criteria :fail
+
+          expect(@dangerfile).to have_error(@message)
+          expect(@dangerfile).to have_no_warning
+        end
+
+        it 'continues if contains acceptance criteria' do
+          allow(@plugin).to receive(:feature_branch?).and_return(true)
+          allow(@plugin.github).to receive(:pr_body).and_return('acceptance criteria : Good example')
+
+          @plugin.check_acceptance_criteria
+
+          expect(@dangerfile).to have_no_warning
+          expect(@dangerfile).to have_no_error
+        end
+      end
+    end
+  end
+end

data/spec/samsao_branching_model_spec.rb

@@ -15,7 +15,7 @@ module Danger
           it "continues on #{branch_prefix}/ prefix" do
             allow(@plugin.github).to receive(:branch_for_head).and_return("#{branch_prefix}/something")
 
-            @plugin.fail_when_wrong_branching_model
+            @plugin.check_wrong_branching_model
 
             expect(@dangerfile).to have_no_error
           end
@@ -24,7 +24,7 @@ module Danger
         it 'fails on wrong prefix' do
           allow(@plugin.github).to receive(:branch_for_head).and_return('wrong/12')
 
-          @plugin.fail_when_wrong_branching_model
+          @plugin.check_wrong_branching_model
 
           expect(@dangerfile).to have_error(@wrong_branching_model)
         end
@@ -32,7 +32,7 @@ module Danger
         it 'fails on good prefix but wrong format' do
           allow(@plugin.github).to receive(:branch_for_head).and_return('feature_12')
 
-          @plugin.fail_when_wrong_branching_model
+          @plugin.check_wrong_branching_model
 
           expect(@dangerfile).to have_error(@wrong_branching_model)
         end

data/spec/samsao_changelog_updated_spec.rb

@@ -15,7 +15,7 @@ module Danger
         it 'continues on support branch' do
           allow(@plugin.github).to receive(:branch_for_head).and_return('support/a')
 
-          @plugin.fail_when_changelog_update_missing
+          @plugin.check_changelog_update_missing
 
           expect(@dangerfile).to have_no_error
         end
@@ -25,7 +25,7 @@ module Danger
             allow(@plugin.github).to receive(:branch_for_head).and_return("#{branch}/a")
             allow(@plugin.git).to receive(:modified_files).and_return(['CHANGELOG.md'])
 
-            @plugin.fail_when_changelog_update_missing
+            @plugin.check_changelog_update_missing
 
             expect(@dangerfile).to have_no_error
           end
@@ -34,7 +34,7 @@ module Danger
             allow(@plugin.github).to receive(:branch_for_head).and_return("#{branch}/a")
             allow(@plugin.git).to receive(:modified_files).and_return([])
 
-            @plugin.fail_when_changelog_update_missing
+            @plugin.check_changelog_update_missing
 
             expect(@dangerfile).to have_error(@changelog_needs_update)
           end
@@ -48,7 +48,7 @@ module Danger
           allow(@plugin.github).to receive(:branch_for_head).and_return('fix/a')
           allow(@plugin.git).to receive(:modified_files).and_return(['CHANGELOG.yml'])
 
-          @plugin.fail_when_changelog_update_missing
+          @plugin.check_changelog_update_missing
 
           expect(@dangerfile).to have_no_error
         end
@@ -61,7 +61,7 @@ module Danger
           allow(@plugin.github).to receive(:branch_for_head).and_return('fix/a')
           allow(@plugin.git).to receive(:modified_files).and_return(['web/CHANGELOG.md'])
 
-          @plugin.fail_when_changelog_update_missing
+          @plugin.check_changelog_update_missing
 
           expect(@dangerfile).to have_no_error
         end
@@ -70,7 +70,7 @@ module Danger
           allow(@plugin).to receive(:trivial_change?).and_return(true)
           allow(@plugin.git).to receive(:modified_files).and_return([])
 
-          @plugin.fail_when_changelog_update_missing
+          @plugin.check_changelog_update_missing
 
           expect(@dangerfile).to have_no_error
         end
@@ -83,7 +83,7 @@ module Danger
           allow(@plugin).to receive(:support_branch?).and_return(true)
           allow(@plugin.git).to receive(:modified_files).and_return([])
 
-          @plugin.fail_when_changelog_update_missing
+          @plugin.check_changelog_update_missing
 
           expect(@dangerfile).to have_no_error
         end
@@ -96,7 +96,7 @@ module Danger
           allow(@plugin).to receive(:support_branch?).and_return(true)
           allow(@plugin.git).to receive(:modified_files).and_return([])
 
-          @plugin.fail_when_changelog_update_missing
+          @plugin.check_changelog_update_missing
 
           expect(@dangerfile).to have_error(@changelog_needs_update)
         end

data/spec/samsao_config_spec.rb

@@ -79,6 +79,34 @@ module Danger
           expect { @plugin.config { project_type 'custom' } }.to raise_error(message)
         end
       end
+
+      describe 'config jira_project_key' do
+        it 'accepts jira project key' do
+          jira_project_key = 'VER'
+
+          @plugin.config do
+            jira_project_key jira_project_key
+          end
+
+          expect(@plugin.config.jira_project_key).to eq(jira_project_key)
+        end
+
+        it 'reject invalid jira project key containing numbers' do
+          jira_project_key = '123'
+          message = "Jira project key '#{jira_project_key}' is invalid, must be"\
+                    ' uppercase and between 1 and 10 characters'
+
+          expect { @plugin.config { jira_project_key jira_project_key } }.to raise_error(message)
+        end
+
+        it 'reject invalid jira project key containing lowercase characters' do
+          jira_project_key = 'invalid'
+          message = "Jira project key '#{jira_project_key}' is invalid, must be"\
+                    ' uppercase and between 1 and 10 characters'
+
+          expect { @plugin.config { jira_project_key jira_project_key } }.to raise_error(message)
+        end
+      end
     end
   end
 end