rainforest-cli 1.8.1 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8ebce969390e9bd4edb7ec29c60e7d632b25ca21
-  data.tar.gz: 8fc2642b449ffc4a6c1ed1bf1380e7d114b41336
+  metadata.gz: 36eb7257778cfda59e340fea593c2b9662390949
+  data.tar.gz: 0c9d06828b51075a1ccd95b2710200ad94e6e5ac
 SHA512:
-  metadata.gz: 701e04c3ef84d559860924808585871b7fa4d92a99aec76467e57a695efd253dd2ea69cb0aad7872a1db3bf8f48ea7dd04191c9e178c5efa671aaaca88b7b298
-  data.tar.gz: e70f3c87c281024b2d6e97f3e618cd3b1a4f3fb77452600625adef6e686c3eeb620591cf4819493287499840ca9062b4a2383851846e5fce00d8076de8b12198
+  metadata.gz: ccddbb99af989e0d96f9761c67ed2a2a2dc9d1731264890d78adb8adb16170c51da4b17ca168c3cb602e21a793feb324307b4adf4d7195d78f27c45773b00cf5
+  data.tar.gz: 417541f667b2485f05f1b9528822832b19ac083489bff2fd93d79d90ff5a7c80a4dca3282f902fe61a9da291e1efe129b9dfcba838d6d80a9be35b6ba33725cd

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Rainforest CLI Changelog
 
+## 1.9.0 - 14th September 2016
+- Add `upload-csv` command for updating tabular variables without starting a new run.
+(069e943cd94cbb08e6f00347ab6c8327372897ce, @epaulet)
+- Add ability to filter uploads with `tag` and `site-id` and to upload specific test by file path.
+(1d6e0a39d664e4c2d2135fa654571c28aaaac031, @epaulet)
+
 ## 1.8.1 - 19th August 2016
 - Fix a bug that prevent uploading tests as a result from 1.8.0.
 (651514ae94df6857c43e820fff60cdf8034f534d, @epaulet)

data/README.md

@@ -88,6 +88,12 @@ Upload tests to Rainforest
 rainforest upload
 ```
 
+Upload a specific test to Rainforest
+
+```bash
+rainforest upload /path/to/test/file.rfml
+```
+
 Remove RFML file and remove test from Rainforest test suite.
 
 ```bash
@@ -128,6 +134,13 @@ To generate a junit xml report for a test run which has already completed
 rainforest report --run-id <run-id> --junit-file rainforest.xml
 ```
 
+#### Updating Tabular Variables
+
+Upload a CSV file to update your tabular variables
+```bash
+rainforest csv-upload --import-variable-csv-file PATH/TO/CSV.csv --import-variable-name my_variable
+```
+
 ## Options
 
 ### General

data/lib/rainforest_cli.rb

@@ -41,6 +41,7 @@ module RainforestCli
     when 'upload' then Uploader.new(options).upload
     when 'rm' then Deleter.new(options).delete
     when 'export' then Exporter.new(options).export
+    when 'csv-upload' then CSVImporter.new(options).import
     when 'report' then Reporter.new(options).report
     when 'sites', 'folders', 'browsers'
       Resources.new(options).public_send(options.command)

data/lib/rainforest_cli/csv_importer.rb

@@ -6,12 +6,9 @@ require 'ruby-progressbar'
 
 module RainforestCli
   class CSVImporter
-    attr_reader :client
-
-    def initialize name, file, token
-      @generator_name = name
-      @file = file
-      @client = HttpClient.new token: token
+    def initialize(options)
+      @generator_name = options.import_name
+      @file = options.import_file_name
     end
 
     def row_data columns, values
@@ -31,7 +28,7 @@ module RainforestCli
       raise 'Invalid schema in CSV. You must include headers in first row.' if !columns
 
       print 'Creating custom step variable'
-      response = client.post '/generators', { name: @generator_name, description: @generator_name, columns: columns }
+      response = http_client.post '/generators', { name: @generator_name, description: @generator_name, columns: columns }
       raise "Error creating custom step variable: #{response['error']}" if response['error']
       puts "\t[OK]"
 
@@ -43,9 +40,15 @@ module RainforestCli
 
       # Insert the data
       Parallel.each(rows, in_threads: 16, finish: lambda { |_item, _i, _result| p.increment }) do |row|
-        response = client.post("/generators/#{@generator_id}/rows", {data: row_data(@columns, row)})
+        response = http_client.post("/generators/#{@generator_id}/rows", {data: row_data(@columns, row)})
         raise response['error'] if response['error']
       end
     end
+
+    private
+
+    def http_client
+      RainforestCli.http_client
+    end
   end
 end

data/lib/rainforest_cli/options.rb

@@ -135,7 +135,7 @@ module RainforestCli
 
       @command = @args.shift
 
-      if ['new', 'rm'].include?(@command)
+      if ['new', 'rm', 'upload'].include?(@command)
         @file_name = @args.shift
 
         if @file_name && @command == 'rm'
@@ -187,6 +187,8 @@ module RainforestCli
         end
       elsif import_file_name || import_name
         raise ValidationError, 'You must pass both --import-variable-csv-file and --import-variable-name'
+      elsif command == 'csv-upload'
+        raise ValidationError, 'You must pass both --import-variable-csv-file and --import-variable-name with the csv-upload command'
       end
 
       if command == 'rm' && file_name.nil?

data/lib/rainforest_cli/runner.rb

@@ -16,7 +16,7 @@ module RainforestCli
 
       if options.import_file_name && options.import_name
         delete_generator(options.import_name)
-        CSVImporter.new(options.import_name, options.import_file_name, options.token).import
+        CSVImporter.new(options).import
       end
 
       post_opts = make_create_run_options

data/lib/rainforest_cli/test_files.rb

@@ -39,15 +39,7 @@ EOF
   end
 
   def test_data
-    if @test_data.nil?
-      @test_data = []
-      if Dir.exist?(@test_folder)
-        Dir.glob(test_paths) do |file_name|
-          @test_data << RainforestCli::TestParser::Parser.new(file_name).process
-        end
-      end
-    end
-    @test_data
+    @test_data ||= get_test_data
   end
 
   def file_extension
@@ -94,6 +86,28 @@ EOF
 
   private
 
+  def get_test_data
+    if @options.file_name
+      [RainforestCli::TestParser::Parser.new(@options.file_name).process]
+    else
+      data = []
+      if Dir.exist?(@test_folder)
+        Dir.glob(test_paths) do |file_name|
+          data << RainforestCli::TestParser::Parser.new(file_name).process
+        end
+      end
+      filter_tests(data)
+    end
+  end
+
+  def filter_tests(tests)
+    tests.select do |test|
+      pass_tag_filter = (@options.tags - test.tags).empty?
+      pass_site_filter = @options.site_id.nil? || @options.site_id == test.site_id
+      pass_tag_filter || pass_site_filter
+    end
+  end
+
   def unique_path(file_path)
     path = file_path[0...-file_extension.length]
     identifier = 0

data/lib/rainforest_cli/test_parser/step.rb

@@ -15,10 +15,28 @@ class RainforestCli::TestParser::Step < Struct.new(:action, :response, :redirect
   end
 
   def uploadable_in_action
-    action.scan(UPLOADABLE_REGEX)
+    action.scan(UPLOADABLE_REGEX).select do |match|
+      needs_parameterization?(match)
+    end
   end
 
   def uploadable_in_response
-    response.scan(UPLOADABLE_REGEX)
+    response.scan(UPLOADABLE_REGEX).select do |match|
+      needs_parameterization?(match)
+    end
+  end
+
+  private
+
+  def needs_parameterization?(match)
+    argument = match[1]
+    parameters = argument.split(',').map(&:strip)
+    if parameters.length >= 2
+      has_file_id = parameters[0].to_i > 0
+      has_file_sig = parameters[1].length == 6
+      !(has_file_id && has_file_sig)
+    else
+      true
+    end
   end
 end

data/lib/rainforest_cli/version.rb

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

data/spec/multiple-rainforest-examples/example_test.rfml

@@ -0,0 +1,8 @@
+#! example_test (Test ID - only edit if this test has not yet been uploaded)
+# title: Example Test
+# tags: foo,bar,baz
+# site_id: 456
+# start_uri: /start_uri
+
+This is a step action.
+This is a question?

data/spec/multiple-rainforest-examples/example_test_2.rfml

@@ -0,0 +1,6 @@
+#! example_test (Test ID - only edit if this test has not yet been uploaded)
+# title: Example Test 2
+# start_uri: /start_uri
+
+This is step action #2.
+This is question #2?

data/spec/rainforest_cli/csv_importer_spec.rb

@@ -1,9 +1,15 @@
 # frozen_string_literal: true
 describe RainforestCli::CSVImporter do
   let(:csv_file) { "#{File.dirname(__FILE__)}/../fixtures/variables.txt" }
+  let(:http_client) { instance_double('RainforestCli::HttpClient') }
+
+  before do
+    allow(RainforestCli).to receive(:http_client).and_return(http_client)
+  end
 
   describe '.import' do
-    subject { described_class.new('variables', csv_file, 'abc123') }
+    let(:options) { instance_double('RainforestCli::Options', import_name: 'variables', import_file_name: csv_file) }
+    subject { described_class.new(options) }
     let(:columns) { %w(email pass) }
 
     let(:success_response) do
@@ -14,7 +20,7 @@ describe RainforestCli::CSVImporter do
     end
 
     it 'should post the schema to the generators API' do
-      expect_any_instance_of(RainforestCli::HttpClient).to receive(:post)
+      expect(http_client).to receive(:post)
                               .with('/generators', {
                                       name: 'variables',
                                       description: 'variables',
@@ -22,7 +28,7 @@ describe RainforestCli::CSVImporter do
                                     })
                               .and_return success_response
 
-      expect_any_instance_of(RainforestCli::HttpClient).to receive(:post)
+      expect(http_client).to receive(:post)
                               .with('/generators/12345/rows', {
                                       data: {
                                         0 => 'russ@rainforestqa.com',
@@ -30,7 +36,7 @@ describe RainforestCli::CSVImporter do
                                       },
                                     }).and_return({})
 
-      expect_any_instance_of(RainforestCli::HttpClient).to receive(:post)
+      expect(http_client).to receive(:post)
                               .with('/generators/12345/rows', {
                                       data: {
                                         0 => 'bob@example.com',

data/spec/rainforest_cli/test_files_spec.rb

@@ -5,7 +5,7 @@ describe RainforestCli::TestFiles do
 
   describe '#test_data' do
     let(:test_directory) { File.dirname(__FILE__) + '/../rainforest-example' }
-    let(:options) { instance_double('RainforestCli::Options', test_folder: test_directory, command: nil) }
+    let(:options) { instance_double('RainforestCli::Options', test_folder: test_directory, command: nil, file_name: nil, tags: [], site_id: nil) }
 
     let(:rfml_test) { subject.test_data.first }
     let(:text_file) { File.read(test_directory + '/example_test.rfml') }
@@ -14,6 +14,15 @@ describe RainforestCli::TestFiles do
       expect(rfml_test.title).to eq(text_file.match(/^# title: (.+)$/)[1])
       expect(rfml_test.rfml_id).to eq(text_file.match(/^#! (.+?)($| .+?$)/)[1])
     end
+
+    context 'when filtering by file name' do
+      let(:file_name) { File.join(File.dirname(__FILE__), '../multiple-rainforest-examples/example_test.rfml') }
+      let(:options) { instance_double('RainforestCli::Options', test_folder: nil, command: nil, file_name: file_name, tags: [], site_id: nil) }
+
+      it 'only parses that file' do
+        expect(subject.test_data.length).to eq(1)
+      end
+    end
   end
 
   describe '#test_dictionary' do

data/spec/rainforest_cli/test_parser/step_spec.rb

@@ -9,6 +9,14 @@ describe RainforestCli::TestParser::Step do
     'Download 1: {{ file.download(./foo) }}. Download 2: {{file.download(bar/baz)   }}'
   end
 
+  let(:parameterized_screenshot_string) do
+    'Picture 1: {{ file.screenshot(./foo) }}. Picture 2: {{file.screenshot(123, signat)   }}'
+  end
+
+  let(:parameterized_download_string) do
+    'Download 1: {{ file.download(./foo) }}. Download 2: {{file.download(123, signat, baz.txt)   }}'
+  end
+
   shared_examples 'a method that detects step variables' do |att|
     it 'correctly detects a screenshot step variable' do
       subject[att] = screenshot_string
@@ -16,11 +24,23 @@ describe RainforestCli::TestParser::Step do
         .to eq([['screenshot', './foo'], ['screenshot', 'bar/baz']])
     end
 
-    it 'correctly detects the download step variable' do
+    it 'correctly detects a download step variable' do
       subject[att] = download_string
       expect(subject.send(:"uploadable_in_#{att}"))
         .to eq([['download', './foo'], ['download', 'bar/baz']])
     end
+
+    it 'does not detect a parameterized screenshot step variable' do
+      subject[att] = parameterized_screenshot_string
+      expect(subject.send(:"uploadable_in_#{att}"))
+        .to eq([['screenshot', './foo']])
+    end
+
+    it 'does not detect a parameterized download step variable' do
+      subject[att] = parameterized_download_string
+      expect(subject.send(:"uploadable_in_#{att}"))
+        .to eq([['download', './foo']])
+    end
   end
 
   describe '#uploadable_in_action' do

data/spec/rainforest_cli/uploader_spec.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 describe RainforestCli::Uploader do
-  let(:options) { instance_double('RainforestCli::Options', token: 'foo', test_folder: test_directory, command: '') }
+  let(:options) { instance_double('RainforestCli::Options', token: 'foo', test_folder: test_directory, command: '', file_name: nil, tags: [], site_id: nil) }
   subject { described_class.new(options) }
 
   before do

data/spec/rainforest_cli/validator_spec.rb

@@ -26,7 +26,7 @@ describe RainforestCli::Validator do
 
   shared_examples 'it detects all the correct errors' do
     let(:tested_method) { :validate }
-    let(:options) { instance_double('RainforestCli::Options', test_folder: test_directory, token: 'api_token', command: '', tags: [], folder: nil, site_id: nil) }
+    let(:options) { instance_double('RainforestCli::Options', test_folder: test_directory, token: 'api_token', command: '', tags: [], folder: nil, site_id: nil, file_name: nil) }
     subject { described_class.new(options) }
 
     before do
@@ -93,7 +93,7 @@ describe RainforestCli::Validator do
 
     context 'when multiple tests have the same rfml_ids' do
       let(:test_directory) { File.expand_path(File.dirname(__FILE__) + '/../validation-examples/duplicate_rfml_ids') }
-      let(:options) { instance_double('RainforestCli::Options', test_folder: test_directory, token: 'api_token', command: '') }
+      let(:options) { instance_double('RainforestCli::Options', test_folder: test_directory, token: 'api_token', command: '', file_name: nil, tags: [], site_id: nil) }
 
       subject { described_class.new(options) }
 
@@ -130,7 +130,7 @@ describe RainforestCli::Validator do
 
     context 'without a token option' do
       let(:test_directory) { File.expand_path(File.dirname(__FILE__) + '/../validation-examples') }
-      let(:options) { instance_double('RainforestCli::Options', test_folder: test_directory, command: '') }
+      let(:options) { instance_double('RainforestCli::Options', test_folder: test_directory, command: '', file_name: nil, tags: [], site_id: nil) }
       let(:http_client) { instance_double('RainforestCli::HttpClient', api_token_set?: false) }
       subject { described_class.new(options) }
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rainforest-cli
 version: !ruby/object:Gem::Version
-  version: 1.8.1
+  version: 1.9.0
 platform: ruby
 authors:
 - Russell Smith
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-20 00:00:00.000000000 Z
+date: 2016-09-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -217,6 +217,8 @@ files:
 - spec/fixtures/runs_response.json
 - spec/fixtures/tests_response.json
 - spec/fixtures/variables.txt
+- spec/multiple-rainforest-examples/example_test.rfml
+- spec/multiple-rainforest-examples/example_test_2.rfml
 - spec/rainforest-example/example_test.rfml
 - spec/rainforest_cli/csv_importer_spec.rb
 - spec/rainforest_cli/deleter_spec.rb
@@ -285,6 +287,8 @@ test_files:
 - spec/fixtures/runs_response.json
 - spec/fixtures/tests_response.json
 - spec/fixtures/variables.txt
+- spec/multiple-rainforest-examples/example_test.rfml
+- spec/multiple-rainforest-examples/example_test_2.rfml
 - spec/rainforest-example/example_test.rfml
 - spec/rainforest_cli/csv_importer_spec.rb
 - spec/rainforest_cli/deleter_spec.rb