rainforest-cli 1.6.2 → 1.6.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cfb05eb0bdff0095e0a44c423194b3b459bdbb79
-  data.tar.gz: 8addbf360bbf94f0adfd7743a665d9ccb885d70b
+  metadata.gz: e77dec4702b93e1e965863ef17de691657fd03ae
+  data.tar.gz: 578b1fa55a182adf52f74c1f2201219c4af1c72a
 SHA512:
-  metadata.gz: c3c2f2e1e31bf0c05551d737b7c158704d3e7cc9bddc16d51f90a105e46e9bdda94e6196ff22dfe69e37bc774c706eaadfb9597c951e4a23882c845157633498
-  data.tar.gz: 57c05636248d4edd5441ff6c2837c5470c3d71d7fc05114bafce51949d44dbcaad68def947317e353c7c4abf1027ba57288ab6f6d97bed62e54ee16eebcc675a
+  metadata.gz: 2f9ff110e6d916871ad66b1c47ab4e19c02392629a97f9c5de5f7ad8337382a3b068dad60252163ecc31be684cc5aaa53d1b4c162b685298f2b01a5f1abbd8ea
+  data.tar.gz: 09a7e1779f9cec02042ee8845ae9f89a7e99718b8245f7a45f65bdd4beffe162d1819afae81557cdd923756b3888a42d5ab2765338478aa3f14a0457732b54f4

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Rainforest CLI Changelog
 
+## 1.6.4 - 10th June 2016
+- Add redirects to non-embedded steps that need them as well. (2a5918d1a448f78016587c1711261e90a7be120f,
+@epaulet)
+- Fix a bug introduced in 1.6.1 where validating without an API token would result in an error.
+(b604a5607e707057375ecc14db836d4b3ec537b1, @epaulet)
+
+## 1.6.3 - 9th June 2016
+- Add redirects to exported steps. (ccbdaec2a9fb52c775ffbee05e203e1026b256f7, @theonegri)
+
 ## 1.6.2 - 8th June 2016
 - Lower concurrent thread count to 16 and allow users to modify the amount of threads used.
 (4333fca172e4e109a517ff6ffc5e11f89839fe85, @epaulet)

data/README.md

@@ -32,13 +32,17 @@ You can customize the amount of threads to use when making HTTP requests by sett
 API errors when fetching or updating multiple tests, lowering this value can help.
 The default value is `16`.
 
-Run all of your tests
+#### Commands
+
+###### Running Tests
+
+Run all tests.
 
 ```bash
 rainforest run all
 ```
 
-Run all in the foreground and report
+Run all in the foreground and report.
 
 ```bash
 rainforest run all --fg
@@ -50,6 +54,8 @@ Run all tests with tag 'run-me' and abort previous in-progress runs.
 rainforest run --tag run-me --fg --conflict abort
 ```
 
+###### Creating and Managing Tests
+
 Create new Rainforest test in RFML format (Rainforest Markup Language).
 
 ```bash
@@ -62,6 +68,14 @@ You may also specify a custom test title or file name.
 rainforest new "My Awesome Title"
 ```
 
+Validate your tests for syntax and correct RFML ids for embedded tests.
+Use the `--token` options or `RAINFOREST_API_TOKEN` environment variable
+to validate your tests against server data as well.
+
+```bash
+rainforest validate
+```
+
 Upload tests to Rainforest
 
 ```bash
@@ -73,6 +87,8 @@ Export all tests from Rainforest
 rainforest export
 ```
 
+###### Viewing Account Specific Information
+
 See a list of all of your sites and their IDs
 ```bash
 rainforest sites

data/lib/rainforest/cli/exporter.rb

@@ -11,6 +11,7 @@ class RainforestCli::Exporter
     @options = options
     ::Rainforest.api_key = @options.token
     @test_files = RainforestCli::TestFiles.new(@options)
+    @remote_tests = RainforestCli::RemoteTests.new(@options.token)
   end
 
   def logger
@@ -26,8 +27,9 @@ class RainforestCli::Exporter
       if @options.tests.length > 0
         @options.tests
       else
-        Rainforest::Test.all(page_size: 1000).map { |t| t.id }
+        @remote_tests.primary_ids
       end
+
     p = ProgressBar.create(title: 'Tests', total: test_ids.count, format: '%a %B %p%% %t')
     Parallel.each(test_ids, in_threads: threads, finish: lambda { |_item, _i, _result| p.increment }) do |test_id|
       # Get the full test from the API
@@ -41,8 +43,9 @@ class RainforestCli::Exporter
       File.open(file_name, 'a') do |file|
         file.puts(get_header(test))
 
+        first_step_processed = false
         test.elements.each_with_index do |element, index|
-          process_element(file, element, index)
+          first_step_processed = process_element(file, element, index, first_step_processed)
         end
       end
     end
@@ -50,25 +53,34 @@ class RainforestCli::Exporter
 
   private
 
-  def process_element file, element, index
+  def process_element(file, element, index, first_step_processed)
     case element[:type]
     when 'test'
       if @options.embed_tests
         file.puts '' unless index == 0
+        # no redirect if an embedded test is the first step
+        file.puts "# redirect: #{element[:redirection]}" if index > 0
         file.puts "- #{element[:element][:rfml_id]}"
       else
-        element[:element][:elements].each do |sub_element|
-          index = process_element(file, sub_element, index)
+        element[:element][:elements].each_with_index do |sub_element, i|
+          # no redirect flags for flattened tests
+          process_element(file, sub_element, i + index, true)
         end
       end
     when 'step'
       file.puts '' unless index == 0
-      file.puts "# step #{index + 1}" if @options.debug
-      file.puts element[:element][:action].gsub("\n", ' ')
-      file.puts element[:element][:response].gsub("\n", ' ')
+
+      # add redirect for first step if preceded by an embedded test
+      if index > 0 && first_step_processed == false
+        file.puts "# redirect: #{element[:redirection]}"
+      end
+      file.puts element[:element][:action].gsub("\n", ' ').strip
+      file.puts element[:element][:response].gsub("\n", ' ').strip
+      first_step_processed = true
     else
       raise "Unknown element type: #{element[:type]}"
     end
+    first_step_processed
   end
 
   def get_header(test)

data/lib/rainforest/cli/remote_tests.rb

@@ -9,47 +9,45 @@ class RainforestCli::RemoteTests
     !Rainforest.api_key.nil?
   end
 
-  def rfml_ids
-    @rfml_ids ||= primary_key_dictionary.keys
-  end
-
   def tests
     @tests ||= fetch_tests
   end
 
-  def fetch_tests
-    if api_token_set?
-      begin
-        logger.info 'Syncing tests...'
-        tests = Rainforest::Test.all(page_size: 1000)
-        logger.info 'Syncing completed.'
-        tests
-      rescue Rainforest::ApiError => e
-        logger.error "Encountered API Error: #{e.message}"
-        exit 4
-      end
-    else
-      logger.info ''
-      logger.info 'No API Token set. Using local tests only...'
-      logger.info ''
-      []
-    end
+  def rfml_ids
+    @rfml_ids ||= tests.map { |t| t['rfml_id'] }
   end
 
-  def primary_key_dictionary
-    @primary_key_dictionary ||= make_test_dictionary
+  def primary_ids
+    @primary_ids ||= tests.map { |t| t['id'] }
   end
 
-  def logger
-    RainforestCli.logger
+  def primary_key_dictionary
+    @primary_key_dictionary ||= make_test_dictionary
   end
 
   def make_test_dictionary
     primary_key_dictionary = {}
-    rf_tests = @client.get('/tests/rfml_ids')
-    rf_tests.each do |rf_test|
+    tests.each do |rf_test|
       primary_key_dictionary[rf_test['rfml_id']] = rf_test['id']
     end
     primary_key_dictionary
   end
+
+  private
+
+  def logger
+    RainforestCli.logger
+  end
+
+  def fetch_tests
+    if api_token_set?
+      logger.info 'Fetching test data from server...'
+      test_list = @client.get('/tests/rfml_ids')
+      logger.info 'Fetch complete.'
+      test_list
+    else
+      logger.info 'No API Token set. Using local tests only...'
+      []
+    end
+  end
 end

data/lib/rainforest/cli/version.rb

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

data/spec/exporter_spec.rb

@@ -3,7 +3,7 @@ describe RainforestCli::Exporter do
   let(:options) do
     instance_double(
       'RainforestCli::Options',
-      token: nil,
+      token: 'token',
       test_folder: nil,
       command: nil,
       debug: nil,
@@ -18,14 +18,14 @@ describe RainforestCli::Exporter do
     class FileDouble < Array
       alias_method :puts, :push
 
-      # join into a string like a file
-      def include?(str)
-        join("\n").include?(str)
+      def to_s
+        join("\n")
       end
     end
 
     let(:file) { FileDouble.new }
-    let(:tests) { [Rainforest::Test.new(id: 123, title: 'Test title')] }
+    let(:file_str) { file.to_s }
+    let(:tests) { [{ 'id' => 123, 'rfml_id' => 'rfml_id_123' }] }
     let(:embedded_rfml_id) { 'embedded_test_rfml_id' }
     let(:embedded_test) do
       {
@@ -43,8 +43,14 @@ describe RainforestCli::Exporter do
     end
     let(:test_elements) do
       [
+        {
+          type: 'test',
+          redirection: true,
+          element: embedded_test
+        },
         {
           type: 'step',
+          redirection: false,
           element: {
             action: 'Step Action',
             response: 'Step Response'
@@ -52,7 +58,16 @@ describe RainforestCli::Exporter do
         },
         {
           type: 'test',
+          redirection: true,
           element: embedded_test
+        },
+        {
+          type: 'step',
+          redirection: false,
+          element: {
+            action: 'Last step',
+            response: 'Last step?'
+          }
         }
       ]
     end
@@ -81,7 +96,8 @@ describe RainforestCli::Exporter do
       allow_any_instance_of(RainforestCli::TestFiles).to receive(:create_file).and_return('file_name')
       allow(File).to receive(:truncate)
 
-      allow(Rainforest::Test).to receive(:all).and_return(tests)
+      allow_any_instance_of(RainforestCli::HttpClient).to receive(:get).with('/tests/rfml_ids')
+        .and_return(tests)
       allow(Rainforest::Test).to receive(:retrieve).and_return(single_test)
 
       subject.export
@@ -132,37 +148,49 @@ describe RainforestCli::Exporter do
       let(:options) do
         instance_double(
           'RainforestCli::Options',
-          token: nil, test_folder: nil, command: nil,
+          token: 'token', test_folder: nil, command: nil,
           debug: nil, embed_tests: true, tests: [],
         )
       end
 
-      it 'prints an embedded test rfml id rather than the steps' do
+      it 'prints an embedded test rfml id' do
         expect(file).to include("- #{embedded_rfml_id}")
-        expect(file).to_not include('Embedded Action')
-        expect(file).to_not include('Embedded Response')
+        expect(file_str).to_not include('Embedded Action')
+        expect(file_str).to_not include('Embedded Response')
+      end
+
+      it 'prints the redirects in the correct location' do
+        # the first embedded test should not have a redirect before it
+        expect(file_str.scan(/# redirect: true\n- #{embedded_rfml_id}/).count).to eq(1)
+
+        # First real step should have a redirect
+        expect(file_str).to include("# redirect: false\nStep Action")
+
+        # The last step exists but no redirect with it
+        expect(file_str).to include('Last step')
+        expect(file_str).to_not include("# redirect: false\nLast step")
       end
     end
 
     context 'with specific tests' do
-      let(:tests) { (123..127).to_a }
+      let(:test_ids) { (123..127).to_a }
       let(:options) do
         instance_double(
           'RainforestCli::Options',
           token: nil, test_folder: nil, command: nil,
-          debug: nil, embed_tests: nil, tests: tests
+          debug: nil, embed_tests: nil, tests: test_ids
         )
       end
 
       it 'gets specific tests instead of all' do
-        expect(Rainforest::Test).to receive(:retrieve).exactly(tests.length).times
-        expect(Rainforest::Test).to receive(:all).exactly(0).times
+        expect(Rainforest::Test).to receive(:retrieve).exactly(test_ids.length).times
+        expect_any_instance_of(RainforestCli::RemoteTests).to_not receive(:primary_ids)
         subject.export
       end
 
       it 'opens correct number of files' do
-        expect(File).to receive(:open).exactly(tests.length).times
-        expect_any_instance_of(RainforestCli::TestFiles).to receive(:create_file).exactly(tests.length).times
+        expect(File).to receive(:open).exactly(test_ids.length).times
+        expect_any_instance_of(RainforestCli::TestFiles).to receive(:create_file).exactly(test_ids.length).times
         subject.export
       end
     end

data/spec/remote_tests_spec.rb

@@ -23,5 +23,16 @@ describe RainforestCli::RemoteTests do
                       test3['rfml_id'] => test3['id']
                     })
     end
+
+    context 'no api token set' do
+      subject { described_class.new }
+
+      it 'does not make an API call but returns an empty dictionary' do
+        expect_any_instance_of(RainforestCli::HttpClient).to_not receive(:get)
+        dictionary = subject.primary_key_dictionary
+        expect(dictionary).to be_a(Hash)
+        expect(dictionary).to eq({})
+      end
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rainforest-cli
 version: !ruby/object:Gem::Version
-  version: 1.6.2
+  version: 1.6.4
 platform: ruby
 authors:
 - Russell Smith
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-09 00:00:00.000000000 Z
+date: 2016-06-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty