rainforest-cli 1.3.1 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 855968ae7a28f0b1023fd41714fefc0fca6b5ad2
-  data.tar.gz: b4eb76a7382c5645811cbb4cbd97a12eb9385d2a
+  metadata.gz: 70b8d8fad3a7886f4cdff271fc383dca7614061a
+  data.tar.gz: b9bc2a5e63a3b95ad661a6d74212f9b01a8cefee
 SHA512:
-  metadata.gz: 83cf3f5e28a712add5c8077beecfdd869627f911bf9ad66aae75abb7090204ada77c19f450133437f028ca152cc8786198651b5ec4e5b4e168e00025988730d3
-  data.tar.gz: 5615003a01351ffd1d9acd7ba924580f767c2a2d72f1e14ead0be38097e83c3402a2343d71b58b0fa7fc99b77d80f562ea1bec11b34ea272186cc084beb53bd9
+  metadata.gz: c0888185bfefe12bf782dbf73c380b5c75dc3d36bdc8971031b467ff716b152989ebfcafe24ded4c67fe2a190f20a5e87a2ef0fcc8c7ddf880af2cf98ec4be9a
+  data.tar.gz: f0080514d2ae49f2bec4662e746343ab8336e721f97e32f3f00250d340b24444cd4290aaa88bb90b59d7d3bab65676b026c26051ba3247294d62b409e8d574f1

data/CHANGELOG.md

@@ -1,7 +1,12 @@
 # Rainforest CLI Changelog
 
+## 1.4.0
+- Support for new `--version` command. (4362c85fe599a02eaa1b772d184be31e692e934e, @epaulet)
+- Validate duplicate RFML IDs before uploading. (67f71d053c755eaf92c1bd205931e89e903b88c9, @curtis-rainforestqa)
+- Add `folders` commands for a folder ID reference. (4ab19fec0924b4764e140fb3c5aa85f1dbfe4006, @epaulet)
+
 ## 1.3.1 - 11th April 2016
-- Support crowd selection
+- Support crowd selection. (03fedacfb7a6e69a174fb3e0e1fd75218fdbbfa9, @ukd1)
 
 ## 1.3.0 - 7th April 2016
 - Export tests with embedded tests unflattened. (0ed4c62cac8a0d5fbd98f03190d3c18c48ac7119,

data/README.md

@@ -62,6 +62,16 @@ Export all tests from Rainforest
 rainforest export
 ```
 
+See a list of all of your sites and their IDs
+```bash
+rainforest sites
+```
+
+See a list of all of your smart folders and their IDs
+```bash
+rainforest folders
+```
+
 ## Options
 
 ### General
@@ -134,6 +144,7 @@ Popular command line options are:
 - `--description "CI automatic run"` - add an arbitrary description for the run.
 - `--embed-tests` - Use with `rainforest export` to export your tests without extracting the
 steps of an embedded test.
+- `--test-folder /path/to/directory` - Use with `rainforest [new, upload, export]`. If this option is not provided, rainforest-cli will, in the case of 'new' create a directory, or in the case of 'upload' and 'export' use the directory, at the default path `./spec/rainforest/`.
 
 
 #### Specifying Test IDs

data/lib/rainforest/cli.rb

@@ -15,7 +15,7 @@ require 'rainforest/cli/remote_tests'
 require 'rainforest/cli/validator'
 require 'rainforest/cli/exporter'
 require 'rainforest/cli/uploader'
-require 'rainforest/cli/sites'
+require 'rainforest/cli/resources'
 
 module RainforestCli
   def self.start(args)
@@ -30,24 +30,12 @@ module RainforestCli
     end
 
     case options.command
-    when 'run'
-      runner = Runner.new(options)
-      runner.run
-    when 'new'
-      t = TestFiles.new(options)
-      t.create_file
-    when 'validate'
-      t = Validator.new(options)
-      t.validate
-    when 'upload'
-      t = Uploader.new(options)
-      t.upload
-    when 'export'
-      t = Exporter.new(options)
-      t.export
-    when 'sites'
-      t = Sites.new(options)
-      t.list_sites
+    when 'run' then Runner.new(options).run
+    when 'new' then TestFiles.new(options).create_file
+    when 'validate' then Validator.new(options).validate
+    when 'upload' then Uploader.new(options).upload
+    when 'export' then Exporter.new(options).export
+    when 'sites', 'folders' then Resources.new(options).public_send(options.command)
     else
       logger.fatal 'Unknown command'
       exit 2

data/lib/rainforest/cli/options.rb

@@ -53,6 +53,9 @@ module RainforestCli
       # NOTE: Disabling line length cop to allow for consistency of syntax
       # rubocop:disable Metrics/LineLength
       @parsed = ::OptionParser.new do |opts|
+        opts.set_program_name 'Rainforest CLI'
+        opts.version = RainforestCli::VERSION
+
         opts.on('--debug') do
           @debug = true
         end
@@ -138,6 +141,11 @@ module RainforestCli
           exit 0
         end
 
+        opts.on_tail('--version', 'Display gem version') do
+          puts opts.ver
+          exit 0
+        end
+
       end.parse!(@args)
       # rubocop:enable Metrics/LineLength
       # NOTE: end Rubocop exception

data/lib/rainforest/cli/resources.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+class RainforestCli::Resources
+  def initialize(options)
+    @client = RainforestCli::HttpClient.new(token: options.token)
+  end
+
+  def sites
+    sites = @client.get('/sites')
+
+    if sites.empty?
+      logger.info('No sites found on your account.')
+      logger.info('Please visit https://app.rainforestqa.com/settings/sites to create and edit your sites.')
+    else
+      print_table('Site', sites) do |site|
+        { id: site['id'], name: site['name'] }
+      end
+    end
+  end
+
+  def folders
+    folders = @client.get('/folders')
+
+    if folders.empty?
+      logger.info('No folders found on your account.')
+      logger.info('Please visit https://app.rainforestqa.com/folders to create and edit your sites.')
+    else
+      print_table('Folder', folders) do |folder|
+        { id: folder['id'], name: folder['title'] }
+      end
+    end
+  end
+
+  def print_table(resource_name, resources)
+    id_col = "#{resource_name} ID"
+    table_heading = "#{id_col} | #{resource_name} Name"
+    puts table_heading
+    puts '-' * table_heading.length
+    resources.each do |resource|
+      resource_data = yield(resource)
+      puts "#{resource_data[:id].to_s.rjust(id_col.length)} | #{resource_data[:name]}"
+    end
+  end
+
+  private
+
+  def logger
+    RainforestCli.logger
+  end
+end

data/lib/rainforest/cli/validator.rb

@@ -32,7 +32,9 @@ class RainforestCli::Validator
     # (no short-circuiting with ||)
     parsing_errors = has_parsing_errors?
     dependency_errors = has_test_dependency_errors?
-    is_invalid = parsing_errors || dependency_errors
+    duplicate_rfml_id_errors = has_duplicate_rfml_id_errors?
+
+    is_invalid = parsing_errors || dependency_errors || duplicate_rfml_id_errors
 
     logger.info ''
     logger.info(is_invalid ? VALIDATIONS_FAILED : VALIDATIONS_PASSED)
@@ -48,6 +50,21 @@ class RainforestCli::Validator
     end
   end
 
+  def has_duplicate_rfml_id_errors?
+    duped_rfml_ids_and_counts = collect_duplicate_rfml_ids
+    return false unless duped_rfml_ids_and_counts.size > 0
+    duplicate_rfml_ids_notification(duped_rfml_ids_and_counts)
+    true
+  end
+
+  def collect_duplicate_rfml_ids
+    rfml_ids_and_counts = Hash.new(0)
+    local_tests.test_data.each do |test|
+      rfml_ids_and_counts[test.rfml_id] += 1
+    end
+    rfml_ids_and_counts.select {|_, count| count > 1}
+  end
+
   def has_parsing_errors?
     logger.info 'Validating parsing errors...'
     has_parsing_errors = rfml_tests.select { |t| t.errors.any? }
@@ -152,6 +169,16 @@ class RainforestCli::Validator
     logger.error ''
   end
 
+  def duplicate_rfml_ids_notification(duplicate_rfml_ids_and_counts)
+    logger.error "The test ids are not unique!"
+    logger.error ''
+    duplicate_rfml_ids_and_counts.each do |rfml_id, count|
+      count_str = count == 1 ? 'is 1 file' : "are #{count} files"
+      logger.error "\tThere #{count_str} with an id of #{rfml_id}"
+    end
+    logger.error ''
+  end
+
   def logger
     RainforestCli.logger
   end

data/lib/rainforest/cli/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module RainforestCli
-  VERSION = '1.3.1'
+  VERSION = '1.4.0'
 end

data/spec/resources_spec.rb

@@ -0,0 +1,140 @@
+# frozen_string_literal: true
+describe RainforestCli::Resources do
+  let(:options) { instance_double('RainforestCli::Options', token: 'fake_token') }
+  subject { described_class.new(options) }
+
+  describe '#sites' do
+    context 'no sites configured' do
+      before do
+        allow_any_instance_of(RainforestCli::HttpClient).to receive(:get).and_return([])
+      end
+
+      it 'directs you to the site settings' do
+        # first line of text
+        expect(RainforestCli.logger).to receive(:info).with(an_instance_of(String))
+        # second line of text
+        expect(RainforestCli.logger).to receive(:info) do |message|
+          expect(message).to include('/settings/sites')
+        end
+
+        subject.sites
+      end
+    end
+
+    context 'with sites in account' do
+      let(:sites) do
+        [
+          {
+            'id' => 123,
+            'name' => 'The Foo Site'
+          },
+          {
+            'id' => 456,
+            'name'=> 'The Bar Site'
+          },
+          {
+            'id' => 789,
+            'name' => 'The Baz Site'
+          }
+        ]
+      end
+
+      before do
+        allow_any_instance_of(RainforestCli::HttpClient).to receive(:get).and_return(sites)
+      end
+
+      it 'calls the print method' do
+        expect(subject).to receive(:print_table).with('Site', sites).and_yield(sites.first)
+        subject.sites
+      end
+
+      it 'correctly formats the site information in the given block' do
+        expect(subject).to receive(:print_table) do |_resource_name, _resource, &blk|
+          site = sites.first
+          expect(blk.call(site)).to include(id: site['id'], name: site['name'])
+        end
+        subject.sites
+      end
+    end
+  end
+
+  describe '#folders' do
+    context 'no folders in account' do
+      before do
+        allow_any_instance_of(RainforestCli::HttpClient).to receive(:get).and_return([])
+      end
+
+      it 'directs you to the folders page' do
+        # first line of text
+        expect(RainforestCli.logger).to receive(:info).with(an_instance_of(String))
+        # second line of text
+        expect(RainforestCli.logger).to receive(:info) do |message|
+          expect(message).to include('/folders')
+        end
+
+        subject.folders
+      end
+    end
+
+    context 'with folders in account' do
+      let(:folders) do
+        [
+          {
+            'id' => 123,
+            'title' => 'The Foo Folder'
+          },
+          {
+            'id' => 456,
+            'title'=> 'The Bar Folder'
+          },
+          {
+            'id' => 789,
+            'title' => 'The Baz Folder'
+          }
+        ]
+      end
+
+      before do
+        allow_any_instance_of(RainforestCli::HttpClient).to receive(:get).and_return(folders)
+      end
+
+      it 'calls the print method' do
+        expect(subject).to receive(:print_table).with('Folder', folders).and_yield(folders.first)
+        subject.folders
+      end
+
+      it 'correctly formats the site information in the given block' do
+        expect(subject).to receive(:print_table) do |_resource_name, _resource, &blk|
+          folder = folders.first
+          expect(blk.call(folder)).to include(id: folder['id'], name: folder['title'])
+        end
+        subject.folders
+      end
+    end
+  end
+
+  describe '#print_table' do
+    let(:resource_id) { 123456 }
+    let(:resource_name) { 'resource name' }
+    let(:resources) { [ { id: resource_id, name: resource_name } ] }
+
+    it 'prints out the resources' do
+      expect(subject).to receive(:puts) do |message|
+        expect(message).to include('Resource ID')
+        expect(message).to include('Resource Name')
+      end
+
+      # Stub dashed the line dividing table header and body
+      expect(subject).to receive(:puts)
+
+      expect(subject).to receive(:puts) do |message|
+        expect(message).to include(resource_id.to_s)
+        expect(message).to include(resource_name)
+      end
+
+      subject.print_table('Resource', resources) do
+        { id: resource_id, name: resource_name }
+      end
+    end
+  end
+end

data/spec/validation-examples/duplicate_rfml_ids/file1.rfml

@@ -0,0 +1,7 @@
+#! a-test
+# title: New test
+# start_uri: /
+#
+
+This is a step action.
+This is a step question?

data/spec/validation-examples/duplicate_rfml_ids/file2.rfml

@@ -0,0 +1,7 @@
+#! a-test
+# title: Some other test
+# start_uri: /
+#
+
+This is another action.
+This is another question?

data/spec/validator_spec.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 describe RainforestCli::Validator do
-  let(:rfml_id_regex) { /^#! (.+?)($| .+?$)/ }
   let(:file_path) { File.join(test_directory, correct_file_name) }
 
   def notifies_with_correct_file_name
@@ -29,6 +28,8 @@ describe RainforestCli::Validator do
   end
 
   shared_examples 'it detects all the correct errors' do
+    let(:tested_method) { :validate }
+    let(:raises_error) { false }
     let(:options) { instance_double('RainforestCli::Options', test_folder: test_directory, token: 'api_token') }
     subject { described_class.new(options) }
 
@@ -92,10 +93,24 @@ describe RainforestCli::Validator do
   end
 
   describe '#validate' do
-    let(:tested_method) { :validate }
-    let(:raises_error) { false }
-
     it_behaves_like 'it detects all the correct errors'
+
+    context 'when multiple tests have the same rfml_ids' do
+      let(:test_directory) { File.expand_path(File.join(__FILE__, '../validation-examples/duplicate_rfml_ids')) }
+      let(:options) { instance_double('RainforestCli::Options', test_folder: test_directory, token: 'api_token') }
+
+      subject { described_class.new(options) }
+
+      before do
+        allow(subject).to receive(:remote_rfml_ids) { [] }
+      end
+
+      it 'logs the errors' do
+        expect(subject).to receive(:duplicate_rfml_ids_notification).with({'a-test' => 2}).and_call_original
+
+        subject.validate
+      end
+    end
   end
 
   describe '#validate_with_exception!' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rainforest-cli
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.4.0
 platform: ruby
 authors:
 - Russell Smith
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-11 00:00:00.000000000 Z
+date: 2016-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -169,8 +169,8 @@ files:
 - lib/rainforest/cli/http_client.rb
 - lib/rainforest/cli/options.rb
 - lib/rainforest/cli/remote_tests.rb
+- lib/rainforest/cli/resources.rb
 - lib/rainforest/cli/runner.rb
-- lib/rainforest/cli/sites.rb
 - lib/rainforest/cli/test_files.rb
 - lib/rainforest/cli/test_parser.rb
 - lib/rainforest/cli/uploader.rb
@@ -193,8 +193,8 @@ files:
 - spec/redirection-examples/wrong_redirect_embedded.rfml
 - spec/redirection-examples/wrong_redirect_spacing.rfml
 - spec/remote_tests_spec.rb
+- spec/resources_spec.rb
 - spec/runner_spec.rb
-- spec/sites_spec.rb
 - spec/spec_helper.rb
 - spec/test_files_spec.rb
 - spec/test_parser_spec.rb
@@ -203,6 +203,8 @@ files:
 - spec/validation-examples/circular_embeds/test2.rfml
 - spec/validation-examples/correct_embeds/embedded_test.rfml
 - spec/validation-examples/correct_embeds/test_with_embedded.rfml
+- spec/validation-examples/duplicate_rfml_ids/file1.rfml
+- spec/validation-examples/duplicate_rfml_ids/file2.rfml
 - spec/validation-examples/missing_embeds/correct_test.rfml
 - spec/validation-examples/missing_embeds/incorrect_test.rfml
 - spec/validation-examples/parse_errors/no_parse_errors.rfml
@@ -251,8 +253,8 @@ test_files:
 - spec/redirection-examples/wrong_redirect_embedded.rfml
 - spec/redirection-examples/wrong_redirect_spacing.rfml
 - spec/remote_tests_spec.rb
+- spec/resources_spec.rb
 - spec/runner_spec.rb
-- spec/sites_spec.rb
 - spec/spec_helper.rb
 - spec/test_files_spec.rb
 - spec/test_parser_spec.rb
@@ -261,6 +263,8 @@ test_files:
 - spec/validation-examples/circular_embeds/test2.rfml
 - spec/validation-examples/correct_embeds/embedded_test.rfml
 - spec/validation-examples/correct_embeds/test_with_embedded.rfml
+- spec/validation-examples/duplicate_rfml_ids/file1.rfml
+- spec/validation-examples/duplicate_rfml_ids/file2.rfml
 - spec/validation-examples/missing_embeds/correct_test.rfml
 - spec/validation-examples/missing_embeds/incorrect_test.rfml
 - spec/validation-examples/parse_errors/no_parse_errors.rfml
@@ -268,3 +272,4 @@ test_files:
 - spec/validation-examples/parse_errors/no_question_mark.rfml
 - spec/validation-examples/parse_errors/no_rfml_id.rfml
 - spec/validator_spec.rb
+has_rdoc: 

data/lib/rainforest/cli/sites.rb

@@ -1,35 +0,0 @@
-# frozen_string_literal: true
-class RainforestCli::Sites
-  def initialize(options)
-    @client = RainforestCli::HttpClient.new(token: options.token)
-  end
-
-  def list_sites
-    sites = fetch_sites
-
-    if sites.empty?
-      logger.info('No configured sites found on your account.')
-      logger.info('Please visit https://app.rainforestqa.com/settings/sites to create and edit your sites.')
-    else
-      print_site_table(sites)
-    end
-  end
-
-  def print_site_table(sites)
-    puts 'Site ID | Site Name'
-    puts '-------------------'
-    sites.each do |site|
-      puts "#{site['id'].to_s.rjust(7)} | #{site['name']}"
-    end
-  end
-
-  private
-
-  def fetch_sites
-    @sites ||= @client.get('/sites')
-  end
-
-  def logger
-    RainforestCli.logger
-  end
-end

data/spec/sites_spec.rb

@@ -1,74 +0,0 @@
-# frozen_string_literal: true
-describe RainforestCli::Sites do
-  let(:options) { instance_double('RainforestCli::Options', token: 'fake_token') }
-  subject { described_class.new(options) }
-
-  let(:sites) do
-    [
-      {
-        'id' => 123,
-        'name' => 'The Foo Site'
-      },
-      {
-        'id' => 456,
-        'name'=> 'The Bar Site'
-      },
-      {
-        'id' => 789,
-        'name' => 'The Baz Site'
-      }
-    ]
-  end
-
-  describe '#list_sites' do
-    context 'no sites configured' do
-      before do
-        allow_any_instance_of(RainforestCli::HttpClient).to receive(:get).and_return([])
-      end
-
-      it 'directs you to the site settings' do
-        # first line of text
-        expect(RainforestCli.logger).to receive(:info).with(an_instance_of(String))
-        # second line of text
-        expect(RainforestCli.logger).to receive(:info) do |message|
-          expect(message).to include('/settings/sites')
-        end
-
-        subject.list_sites
-      end
-    end
-
-    context 'with sites configured' do
-      before do
-        allow_any_instance_of(RainforestCli::HttpClient).to receive(:get).and_return(sites)
-      end
-
-      it 'prints the site table' do
-        expect(subject).to receive(:print_site_table).with(sites)
-        subject.list_sites
-      end
-
-    end
-  end
-
-  describe '#print_site_table' do
-    it 'prints out the sites' do
-      expect(subject).to receive(:puts) do |message|
-        expect(message).to include('Site ID')
-        expect(message).to include('Site Name')
-      end
-
-      # The line dividing table header and body
-      expect(subject).to receive(:puts)
-
-      sites.each do |site|
-        expect(subject).to receive(:puts) do |message|
-          expect(message).to include(site['id'].to_s)
-          expect(message).to include(site['name'])
-        end
-      end
-
-      subject.print_site_table(sites)
-    end
-  end
-end