rainforest-cli 0.0.14 → 0.0.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0f42f5204c7270c3eac865f11542df5a4018a95a
-  data.tar.gz: 4d3e1c7e16bbb265f6d1fb0f9f3602b8f48dc8e5
+  metadata.gz: d6657daf2f5330f8a36eb5b428301d948126a7d9
+  data.tar.gz: f2211772f11f76f7c9c3e0c1c276e8a2fbf76e69
 SHA512:
-  metadata.gz: 39cac3328e88e9d2cc174c0386f135ff11d7cd52b012b0daea620733a3aab1e0f7f0ee02623c156e1a2eb8e69c55422426f2c3a2364aff7c84f447b9e583abc7
-  data.tar.gz: 9cd678e820f6dc9385a2db12b4d5d29ea58dbb50c590a48a055f4723bb734dc5ff9ab2b89046420b408f2aca2cb4196d3b93d19e5190067a6fd694fe55a76d6e
+  metadata.gz: c83670311447e58b3fd6a7dbf389eea91efcef1d2d3e41ce52d35e99e8cb53a158cb3c974e5ac1fe17e758f2b56bed285cb3359707f89c0d588f8f2fea74a283
+  data.tar.gz: e0f16437e179732e4e9dbf5b2ccec0700f154af7f5612f75299ce7bf7b1e3cb8337eb452e86dbd9becc358748c843368f0f5032977d28ddc1300d0f049e42e13

data/.gitmodules

@@ -0,0 +1,3 @@
+[submodule "spec/test-repo"]
+	path = spec/test-repo
+	url = https://github.com/rainforestapp/test-repo.git

data/.rspec

@@ -1,3 +1,2 @@
 --color
 --require spec_helper
---profile

data/README.md

@@ -38,12 +38,14 @@ The options are:
 - `--fg` - results in the foreground - this is what you want to make the build pass / fail dependent on rainforest results 
 - `--site-id` - only run tests for a specific site. Get in touch with us for help on getting that you site id if you are unable to.
 - `--custom-url` - use a custom url for this run. Example use case: an ad-hoc QA environment with [Fourchette](https://github.com/rainforestapp/fourchette). You will need to specify a `site_id` too for this to work. Please note that we will be creating environments under the hood and will not affect your test permanently.
+- `--git-trigger` - only trigger a run when the last commit (for a git repo in the current working directory) has contains `@rainforest` and a list of one or more tags. E.g. "Fix checkout process. @rainforest #checkout" would trigger a run for everything tagged `checkout`. This over-rides `--tag` and any tests specified. If no `@rainforest` is detected it will exit 0.
 
 
 ## Contributing
 
 1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+2. Make sure you init the submodules (`git submodule init && git submodule update`)
+3. Create your feature branch (`git checkout -b my-new-feature`)
+4. Commit your changes (`git commit -am 'Add some feature'`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create new Pull Request

data/lib/rainforest/cli/git_trigger.rb

@@ -0,0 +1,19 @@
+require 'optparse'
+
+module Rainforest
+  module Cli
+    class GitTrigger
+      def self.git_trigger_should_run?(commit_message)
+        commit_message.include?('@rainforest')
+      end
+
+      def self.extract_hashtags(commit_message)
+        commit_message.scan(/#([\w_-]+)/).flatten.map {|s| s.gsub('#','') }
+      end
+
+      def self.last_commit_message
+        `git log -1 --pretty=%B`.strip
+      end
+    end
+  end
+end

data/lib/rainforest/cli/options.rb

@@ -29,6 +29,10 @@ module Rainforest
             @import_name = value
           end
 
+          opts.on("--git-trigger", "Only run if the last commit contains @rainforestapp") do |value|
+            @git_trigger = true
+          end
+
           opts.on("--fg", "Run the tests in foreground.") do |value|
             @foreground = value
           end
@@ -72,6 +76,10 @@ module Rainforest
         @tests
       end
 
+      def git_trigger?
+        @git_trigger
+      end
+
       def failfast?
         @failfast
       end

data/lib/rainforest/cli/version.rb

@@ -1,5 +1,5 @@
 module Rainforest
   module Cli
-    VERSION = "0.0.14"
+    VERSION = "0.0.15"
   end
 end

data/lib/rainforest/cli.rb

@@ -1,8 +1,10 @@
 require "rainforest/cli/version"
 require "rainforest/cli/options"
+require "rainforest/cli/git_trigger"
 require "rainforest/cli/csv_importer"
 require "httparty"
 require "json"
+require "logger"
 
 module Rainforest
   module Cli 
@@ -11,29 +13,63 @@ module Rainforest
     def self.start(args)
       @options = OptionParser.new(args)
 
+      unless @options.token
+        logger.fatal "You must pass your API token using: --token TOKEN"
+        exit 2
+      end
+
       if @options.custom_url && @options.site_id.nil?
-        puts "The site-id and custom-url options work together, you need both of them."
-        exit 1
+        logger.fatal "The site-id and custom-url options are both required."
+        exit 2
       end
 
       if @options.import_file_name && @options.import_name
         unless File.exists?(@options.import_file_name)
-          puts "Input file: #{@options.import_file_name} not found"
+          logger.fatal "Input file: #{@options.import_file_name} not found"
           exit 2
         end
 
         delete_generator(@options.import_name)
         CSVImporter.new(@options.import_name, @options.import_file_name, @options.token).import
       elsif @options.import_file_name || @options.import_name
-        puts "You must pass both --import-variable-csv-file and --import-variable-name"
+        logger.fatal "You must pass both --import-variable-csv-file and --import-variable-name"
         exit 2
       end
 
       post_opts = {}
-      if !@options.tags.empty?
-        post_opts[:tags] = @options.tags
+
+      if @options.git_trigger?
+        logger.debug "Checking last git commit message:"
+        commit_message = GitTrigger.last_commit_message
+        logger.debug commit_message
+
+        # Show some messages to users about tests/tags being overriden
+        unless @options.tags.empty?
+          logger.warn "Specified tags are ignored when using --git-trigger"
+        else
+          logger.warn "Specified tests are ignored when using --git-trigger"
+        end
+
+        if GitTrigger.git_trigger_should_run?(commit_message)
+          tags = GitTrigger.extract_hashtags(commit_message)
+          if tags.empty?
+            logger.error "Triggered via git, but no hashtags detected. Please use commit message format:"
+            logger.error "\t'some message. @rainforest #tag1 #tag2"
+            exit 2
+          else
+            post_opts[:tags] = [tags.join(',')]
+          end
+        else
+          logger.info "Not triggering as @rainforest was not mentioned in last commit message."
+          exit 0
+        end
       else
-        post_opts[:tests] = @options.tests
+        # Not using git_trigger, so look for the 
+        if !@options.tags.empty?
+          post_opts[:tags] = @options.tags
+        else
+          post_opts[:tests] = @options.tests
+        end
       end
 
       post_opts[:conflict] = @options.conflict if @options.conflict
@@ -43,12 +79,13 @@ module Rainforest
 
       post_opts[:environment_id] = get_environment_id(@options.custom_url) if @options.custom_url
 
-      puts "Issuing run"
+      logger.debug "POST options: #{post_opts.inspect}"
+      logger.info "Issuing run"
 
       response = post(API_URL + '/runs', post_opts)
 
       if response['error']
-        puts "Error starting your run: #{response['error']}"
+        logger.fatal "Error starting your run: #{response['error']}"
         exit 1
       end
 
@@ -62,10 +99,10 @@ module Rainforest
         response = get "#{API_URL}/runs/#{run_id}?gem_version=#{Rainforest::Cli::VERSION}"
         if response 
           if %w(queued in_progress sending_webhook waiting_for_callback).include?(response["state"])
-            puts "Run #{run_id} is #{response['state']} and is #{response['current_progress']['percent']}% complete"
+            logger.info "Run #{run_id} is #{response['state']} and is #{response['current_progress']['percent']}% complete"
             running = false if response["result"] == 'failed' && @options.failfast?
           else
-            puts "Run #{run_id} is now #{response["state"]} and has #{response["result"]}"
+            logger.info "Run #{run_id} is now #{response["state"]} and has #{response["result"]}"
             running = false
           end
         end
@@ -121,8 +158,8 @@ module Rainforest
       begin
         URI.parse(url)
       rescue URI::InvalidURIError
-        puts "The custom URL is invalid"
-        exit 1
+        logger.fatal "The custom URL is invalid"
+        exit 2
       end
 
       env_post_body = { name: 'temporary-env-for-custom-url-via-CLI', url: url }
@@ -131,11 +168,15 @@ module Rainforest
       if environment['error']
         # I am talking about a URL here because the environments are pretty
         # much hidden from clients so far.
-        puts "Error creating the ad-hoc URL: #{environment['error']}"
+        logger.fatal "Error creating the ad-hoc URL: #{environment['error']}"
         exit 1
       end
 
       return environment['id']
     end
+
+    def self.logger
+      @logger ||= Logger.new(STDOUT)
+    end
   end
 end

data/spec/cli_spec.rb

@@ -9,28 +9,120 @@ describe Rainforest::Cli do
     let(:ok_progress) { {"state" => "in_progress", "current_progress" => {"percent" => "1"} } }
 
     context "with bad parameters" do
+      context "no token" do
+        let(:params) { %w(--custom-url http://ad-hoc.example.com) }
+        it 'errors out' do
+          expect_any_instance_of(Logger).to receive(:fatal).with('You must pass your API token using: --token TOKEN')
+          begin
+            described_class.start(params)
+          rescue SystemExit => e
+            # That's fine, this is expected but tested in a differnet assertion
+          end
+        end
+
+        it 'exits with exit code 2' do
+          expect {
+            described_class.start(params)
+          }.to raise_error { |error|
+            expect(error).to be_a(SystemExit)
+            expect(error.status).to eq 2
+          }
+        end
+      end
+
       context "with custom-url with no site-id" do
+        let(:params) { %w(--token x --custom-url http://ad-hoc.example.com) }
+
         it 'errors out' do
-          expect(STDOUT).to receive(:puts).with('The site-id and custom-url options work together, you need both of them.')
+          expect_any_instance_of(Logger).to receive(:fatal).with('The site-id and custom-url options are both required.')
           begin
-            described_class.start(%w(--custom-url http://ad-hoc.example.com))
+            described_class.start(params)
           rescue SystemExit => e
             # That's fine, this is expected but tested in a differnet assertion
           end
         end
 
-        it 'exits with exit code 1' do
+        it 'exits with exit code 2' do
           expect {
-            described_class.start(%w(--custom-url http://ad-hoc.example.com))
+            described_class.start(params)
           }.to raise_error { |error|
             expect(error).to be_a(SystemExit)
-            expect(error.status).to eq 1
+            expect(error.status).to eq 2
           }
         end
       end
     end
 
+    context "git-trigger" do
+      let(:params) { %w(--token x --git-trigger) }
+      let(:commit_message) { 'a test commit message' }
+
+      def start_with_params(params, expected_exit_code = 2)
+        begin
+          described_class.start(params)
+        rescue SystemExit => error
+          expect(error.status).to eq expected_exit_code
+        end
+      end
+
+      before do
+        Rainforest::Cli::GitTrigger.stub(:last_commit_message) { commit_message }
+      end
+      
+      describe "with tags parameter passed" do
+        let(:params) { %w(--token x --tag x --git-trigger) }
+
+        it "warns about the parameter being ignored" do
+          expect_any_instance_of(Logger).to receive(:warn).with("Specified tags are ignored when using --git-trigger")
+          
+          start_with_params(params, 0)
+        end
+      end
+      
+      describe "with tags parameter passed" do
+        let(:params) { %w(all --token x --git-trigger) }
+
+        it "warns about the parameter being ignored" do
+          expect_any_instance_of(Logger).to receive(:warn).with("Specified tests are ignored when using --git-trigger")
+          
+          start_with_params(params, 0)
+        end
+      end
+
+      describe "with no @rainforest in the commit message" do
+        it "exit 0's and logs the reason" do
+          expect_any_instance_of(Logger).to receive(:info).with("Not triggering as @rainforest was not mentioned in last commit message.")
+          start_with_params(params, 0)
+        end
+      end
+
+      describe "with @rainforest in the commit message, but no tags" do
+        let(:commit_message) { 'a test commit message @rainforest' }
+
+        it "exit 2's and logs the reason" do
+          expect_any_instance_of(Logger).to receive(:error).with("Triggered via git, but no hashtags detected. Please use commit message format:")
+          expect_any_instance_of(Logger).to receive(:error).with("\t'some message. @rainforest #tag1 #tag2")
+          
+          start_with_params(params, 2)
+        end
+      end
+
+      describe "with @rainforest in the commit message + hashtags" do
+        let(:commit_message) { 'a test commit message @rainforest #run-me' }
+
+        it "starts the run with the specified tags" do
+          expect(described_class).to receive(:post).with(
+            "http://app.rainforest.dev/api/1/runs",
+            { :tags=>['run-me'], :gem_version=>Rainforest::Cli::VERSION }
+          ).and_return( {} )
+
+          start_with_params(params, 0)
+        end
+      end
+    end
+
     context "with site-id and custom-url" do
+      let(:params) { %w(--token x --site 3 --custom-url http://ad-hoc.example.com) }
       it "creates a new environment" do
         allow(described_class).to receive(:post).and_return { exit }
         expect(described_class).to receive(:post).with(
@@ -48,7 +140,7 @@ describe Rainforest::Cli do
         # call, not the call to create a run, so I exit, but rescue from it here
         # so that the spec doesn't fail. It's horrible, sorry!
         begin
-          described_class.start(%w(--site 3 --custom-url http://ad-hoc.example.com))
+          described_class.start(params)
         rescue SystemExit => e
           # That's fine, this is expected but tested in a differnet assertion
         end
@@ -59,9 +151,9 @@ describe Rainforest::Cli do
 
         expect(described_class).to receive(:post).with(
           "http://app.rainforest.dev/api/1/runs",
-          { :tests=>[], :site_id=>3, :gem_version=>"0.0.13", :environment_id=>333 }
+          { :tests=>[], :site_id=>3, :gem_version=>Rainforest::Cli::VERSION, :environment_id=>333 }
         ).and_return( {} )
-        described_class.start(%w(--site 3 --custom-url http://ad-hoc.example.com))
+        described_class.start(params)
       end
     end
 
@@ -104,12 +196,12 @@ describe Rainforest::Cli do
   describe ".get_environment_id" do
     context "with an invalid URL" do
       it 'errors out and exits' do
-        expect(STDOUT).to receive(:puts).with("The custom URL is invalid")
+        expect_any_instance_of(Logger).to receive(:fatal).with("The custom URL is invalid")
         expect {
           described_class.get_environment_id('http://some=weird')
         }.to raise_error { |error|
           expect(error).to be_a(SystemExit)
-          expect(error.status).to eq 1
+          expect(error.status).to eq 2
         }
       end
     end
@@ -120,7 +212,7 @@ describe Rainforest::Cli do
       end
 
       it 'errors out and exits' do
-        expect(STDOUT).to receive(:puts).with("Error creating the ad-hoc URL: Some API error")
+        expect_any_instance_of(Logger).to receive(:fatal).with("Error creating the ad-hoc URL: Some API error")
         expect {
           described_class.get_environment_id('http://example.com')
         }.to raise_error { |error|

data/spec/git_trigger_spec.rb

@@ -0,0 +1,29 @@
+describe Rainforest::Cli::GitTrigger do
+  subject { described_class }
+
+  describe ".last_commit_message" do
+    it "returns a string" do
+      default_dir = Dir.pwd
+
+      Dir.chdir(File.join([default_dir, 'spec', 'test-repo']))
+      expect(described_class.last_commit_message).to eq "Initial commit"
+      Dir.chdir(default_dir)
+    end
+  end
+
+  describe ".git_trigger_should_run?" do
+    it "returns true when @rainforest is in the string" do
+      expect(described_class.git_trigger_should_run?('hello, world')).to eq false
+      expect(described_class.git_trigger_should_run?('hello @rainforest')).to eq true
+    end
+  end
+
+  describe ".extract_hashtags" do
+    it "returns a list of hashtags" do
+      expect(described_class.extract_hashtags('hello, world')).to eq []
+      expect(described_class.extract_hashtags('#hello, #world')).to eq ['hello', 'world']
+      expect(described_class.extract_hashtags('#hello,#world')).to eq ['hello', 'world']
+      expect(described_class.extract_hashtags('#dashes-work, #underscores_work #007')).to eq ['dashes-work', 'underscores_work', '007']
+    end
+  end
+end

data/spec/options_spec.rb

@@ -41,6 +41,12 @@ describe Rainforest::Cli::OptionParser do
     its(:browsers) { should == ["ie8", "chrome"]}
   end
 
+  context "it parses the --git-trigger flag" do
+    let(:args) { ["run", "--git-trigger", "all"] }
+    its(:tests) { should == ["all"]}
+    its(:git_trigger?) { should be_true }
+  end
+
   context "it parses the --fg flag" do
     let(:args) { ["run", "--fg", "all"] }
     its(:tests) { should == ["all"]}

data.tar.gz.sig

@@ -1,2 +1,3 @@
-Z��K�i�
-�P3�W�wl������Yj����ߌR�
+^uMSy�1by��;.
�)��3H"�m�n.[�yӃ3~���?��়�&BIO_-��<W�?��8貺tp�{�|��z�]�7�7���]O
f}w
+[�N?zpw-va��|DN���]�uT��@'@�r��X�����T��R[3k��S<�
+HCӱ�$3ʁ�`Yn[-�-U�_�w�G���\WB�b�|G���G��&�"̈́�@�I�ۇB�<F��񧥺�j.�Y^��SNy�^�

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rainforest-cli
 version: !ruby/object:Gem::Version
-  version: 0.0.14
+  version: 0.0.15
 platform: ruby
 authors:
 - Simon Mathieu
@@ -32,7 +32,7 @@ cert_chain:
   wWdLLpBZZ1O4GE0uzQovmTiis4iyCF+8tFIgjbM/FVwKUBV6OZpxs4FOBtR1mK6L
   lj0cPcKRm/FZUw==
   -----END CERTIFICATE-----
-date: 2014-09-08 00:00:00.000000000 Z
+date: 2014-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -114,6 +114,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".gitmodules"
 - ".rspec"
 - ".rvmrc"
 - ".travis.yml"
@@ -126,10 +127,12 @@ files:
 - certs/ukd1.pem
 - lib/rainforest/cli.rb
 - lib/rainforest/cli/csv_importer.rb
+- lib/rainforest/cli/git_trigger.rb
 - lib/rainforest/cli/options.rb
 - lib/rainforest/cli/version.rb
 - rainforest-cli.gemspec
 - spec/cli_spec.rb
+- spec/git_trigger_spec.rb
 - spec/options_spec.rb
 - spec/spec_helper.rb
 homepage: https://www.rainforestqa.com/
@@ -158,5 +161,6 @@ specification_version: 4
 summary: Command line utility for Rainforest QA
 test_files:
 - spec/cli_spec.rb
+- spec/git_trigger_spec.rb
 - spec/options_spec.rb
 - spec/spec_helper.rb