rainforest-cli 1.2.2 → 1.3.0

data/lib/rainforest/cli/test_parser.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 module RainforestCli::TestParser
-  class EmbeddedTest < Struct.new(:rfml_id)
+  class EmbeddedTest < Struct.new(:rfml_id, :redirect)
     def type
       :test
     end
@@ -9,10 +9,14 @@ module RainforestCli::TestParser
       "--> embed: #{rfml_id}"
     end
 
+    def redirection
+      redirect || 'true'
+    end
+
     def to_element(primary_key_id)
       {
         type: 'test',
-        redirection: true,
+        redirection: redirection,
         element: {
           id: primary_key_id
         }
@@ -20,11 +24,15 @@ module RainforestCli::TestParser
     end
   end
 
-  class Step < Struct.new(:action, :response)
+  class Step < Struct.new(:action, :response, :redirect)
     def type
       :step
     end
 
+    def redirection
+      redirect || 'true'
+    end
+
     def to_s
       "#{action} --> #{response}"
     end
@@ -32,7 +40,7 @@ module RainforestCli::TestParser
     def to_element
       {
         type: 'step',
-        redirection: true,
+        redirection: redirection,
         element: {
           action: action,
           response: response
@@ -41,7 +49,18 @@ module RainforestCli::TestParser
     end
   end
 
-  class Test < Struct.new(:file_name, :rfml_id, :description, :title, :start_uri, :steps, :errors, :tags, :browsers)
+  class Test < Struct.new(
+    :file_name,
+    :rfml_id,
+    :description,
+    :title,
+    :start_uri,
+    :site_id,
+    :steps,
+    :errors,
+    :tags,
+    :browsers
+  )
     def embedded_ids
       steps.inject([]) { |embeds, step| step.type == :test ? embeds + [step.rfml_id] : embeds }
     end
@@ -68,11 +87,13 @@ module RainforestCli::TestParser
       @test.browsers = []
     end
 
-    TEXT_FIELDS = [:start_uri, :title, :tags].freeze
+    TEST_DATA_FIELDS = [:start_uri, :title, :tags, :site_id].freeze
+    STEP_DATA_FIELDS = [:redirect].freeze
     CSV_FIELDS = [:tags, :browsers].freeze
 
     def process
-      scratch = []
+      step_scratch = []
+      step_settings_scratch = {}
 
       text.lines.each_with_index do |line, line_no|
         line = line.chomp
@@ -85,7 +106,16 @@ module RainforestCli::TestParser
           # comment, store in description
           @test.description += line[1..-1] + "\n"
 
-          (CSV_FIELDS + TEXT_FIELDS).each do |field|
+          if line[1..-1].strip[0..8] == 'redirect:'
+            value = line[1..-1].split(' ')[1..-1].join(' ').strip
+            if %(true false).include?(value)
+              step_settings_scratch[:redirect] = value
+            else
+              @test.errors[line_no] = Error.new(line_no, 'Redirection value must be true or false')
+            end
+          end
+
+          (CSV_FIELDS + TEST_DATA_FIELDS).each do |field|
             next unless line[1..-1].strip[0..(field.length)] == "#{field}:"
 
             # extract just the text of the field
@@ -97,31 +127,35 @@ module RainforestCli::TestParser
             end
           end
 
-        elsif scratch.count == 0 && line.strip != ''
+        elsif step_scratch.count == 0 && line.strip != ''
           if line[0] == '-'
-            @test.steps << EmbeddedTest.new(line[1..-1].strip)
+            @test.steps << EmbeddedTest.new(line[1..-1].strip, step_settings_scratch[:redirect])
+            step_settings_scratch = {}
           else
-            scratch << line.strip
+            step_scratch << line.strip
           end
 
-        elsif scratch.count == 1
+        elsif step_scratch.count == 1
           if line.strip == ''
             @test.errors[line_no] = Error.new(line_no, 'Missing question')
           elsif !line.include?('?')
             @test.errors[line_no] = Error.new(line_no, 'Missing ?')
           else
-            scratch << line.strip
+            step_scratch << line.strip
           end
 
+        elsif line.strip.empty? && step_settings_scratch.any?
+          @test.errors[line_no] = Error.new(line_no, 'Extra space between step attributes and step content.')
         end
 
         if @test.errors.has_key?(line_no)
-          scratch = []
+          step_scratch = []
         end
 
-        if scratch.count == 2
-          @test.steps << Step.new(scratch[0], scratch[1])
-          scratch = []
+        if step_scratch.count == 2
+          @test.steps << Step.new(step_scratch[0], step_scratch[1], step_settings_scratch[:redirect])
+          step_scratch = []
+          step_settings_scratch = {}
         end
       end
 

data/lib/rainforest/cli/uploader.rb

@@ -7,7 +7,7 @@ class RainforestCli::Uploader
   attr_reader :test_files, :remote_tests, :validator
 
   def initialize(options)
-    @test_files = RainforestCli::TestFiles.new(options.test_folder)
+    @test_files = RainforestCli::TestFiles.new(options)
     @remote_tests = RainforestCli::RemoteTests.new(options.token)
     @validator = RainforestCli::Validator.new(options, test_files, remote_tests)
   end
@@ -51,7 +51,8 @@ class RainforestCli::Uploader
     test_obj = {
       title: rfml_test.title,
       start_uri: rfml_test.start_uri,
-      rfml_id: rfml_test.rfml_id
+      rfml_id: rfml_test.rfml_id,
+      source: 'rainforest-cli'
     }
     rf_test = Rainforest::Test.create(test_obj)
 
@@ -82,6 +83,7 @@ class RainforestCli::Uploader
     test_obj = {
       start_uri: rfml_test.start_uri || '/',
       title: rfml_test.title,
+      site_id: rfml_test.site_id,
       description: rfml_test.description,
       source: 'rainforest-cli',
       tags: rfml_test.tags.uniq,

data/lib/rainforest/cli/validator.rb

@@ -7,7 +7,7 @@ class RainforestCli::Validator
   attr_reader :local_tests, :remote_tests
 
   def initialize(options, local_tests = nil, remote_tests = nil)
-    @local_tests = local_tests || RainforestCli::TestFiles.new(options.test_folder)
+    @local_tests = local_tests || RainforestCli::TestFiles.new(options)
     @remote_tests = remote_tests || RainforestCli::RemoteTests.new(options.token)
   end
 

data/lib/rainforest/cli/version.rb

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

data/spec/cli_spec.rb

@@ -173,6 +173,19 @@ describe RainforestCli do
       end
     end
 
+    context 'with token from env' do
+      let(:params) { %w(run) }
+
+      it 'starts the run without error' do
+        expect_any_instance_of(http_client).to receive(:post).with(
+          '/runs',
+          { tests: [] }
+        ).and_return({})
+        allow(ENV).to receive(:[]).with('RAINFOREST_API_TOKEN').and_return('x')
+        described_class.start(params)
+      end
+    end
+
     context 'a simple run' do
       before do
         allow_any_instance_of(http_client).to receive(:post).and_return('id' => 1)

data/spec/csv_importer_spec.rb

@@ -4,14 +4,11 @@ describe RainforestCli::CSVImporter do
 
   describe '.import' do
     subject { described_class.new('variables', csv_file, 'abc123') }
-    let(:progressbar_mock) { double('ProgressBar') }
 
     before do
       # suppress output in terminal
       allow_any_instance_of(described_class).to receive(:print)
       allow_any_instance_of(described_class).to receive(:puts)
-      allow(ProgressBar).to receive(:create).and_return(progressbar_mock)
-      allow(progressbar_mock).to receive(:increment)
     end
 
     let(:columns) { %w(email pass) }

data/spec/exporter_spec.rb

@@ -0,0 +1,140 @@
+# frozen_string_literal: true
+describe RainforestCli::Exporter do
+  let(:options) do
+    instance_double('RainforestCli::Options', token: nil, test_folder: nil, debug: nil, embed_tests: nil, tests: [])
+  end
+  subject { described_class.new(options) }
+
+  describe '#export' do
+    # Collect everything printed to file in an array-like file double object
+    class FileDouble < Array
+      alias_method :puts, :push
+    end
+
+    let(:file) { FileDouble.new }
+    let(:tests) { [Rainforest::Test.new(id: 123, title: 'Test title')] }
+    let(:embedded_rfml_id) { 'embedded_test_rfml_id' }
+    let(:embedded_test) do
+      {
+        rfml_id: embedded_rfml_id,
+        elements: [
+          {
+            type: 'step',
+            element: {
+              action: 'Embedded Action',
+              response: 'Embedded Response'
+            }
+          }
+        ]
+      }
+    end
+    let(:single_test) do
+      Rainforest::Test.new(
+        {
+          id: 123,
+          title: 'Test title',
+          start_uri: '/uri',
+          tags: ['foo', 'bar'],
+          browsers: [
+            {
+              name: 'chrome',
+              state: 'enabled'
+            },
+            {
+              name: 'safari',
+              state: 'enabled'
+            },
+            {
+              name: 'firefox',
+              state: 'disabled'
+            }
+          ],
+          elements: [
+            {
+              type: 'step',
+              element: {
+                action: 'Step Action',
+                response: 'Step Response'
+              }
+            },
+            {
+              type: 'test',
+              element: embedded_test
+            }
+          ]
+        }
+      )
+    end
+
+    before do
+      allow(File).to receive(:open) do |_file_name, _, &blk|
+        blk.call(file)
+      end
+
+      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(Rainforest::Test).to receive(:retrieve).and_return(single_test)
+
+      subject.export
+    end
+
+    it 'prints an action and response for a step' do
+      expect(file).to include('Step Action')
+      expect(file).to include('Step Response')
+    end
+
+    it 'prints embedded steps' do
+      expect(file).to include('Embedded Action')
+      expect(file).to include('Embedded Response')
+      expect(file).to_not include("- #{embedded_rfml_id}")
+    end
+
+    it 'print enabled browsers only' do
+      comments = file[0]
+      expect(comments).to include('chrome')
+      expect(comments).to include('safari')
+      expect(comments).to_not include('firefox')
+    end
+
+    context 'with embed-tests flag' do
+      let(:options) do
+        instance_double(
+          'RainforestCli::Options',
+          token: nil, test_folder: nil,
+          debug: nil, embed_tests: true, tests: []
+        )
+      end
+
+      it 'prints an embedded test rfml id rather than the steps' do
+        expect(file).to include("- #{embedded_rfml_id}")
+        expect(file).to_not include('Embedded Action')
+        expect(file).to_not include('Embedded Response')
+      end
+    end
+
+    context 'with specific tests' do
+      let(:tests) { (123..127).to_a }
+      let(:options) do
+        instance_double(
+          'RainforestCli::Options',
+          token: nil, test_folder: nil, debug: nil,
+          embed_tests: nil, tests: tests
+        )
+      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
+        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
+        subject.export
+      end
+    end
+  end
+end

data/spec/options_spec.rb

@@ -19,6 +19,11 @@ describe RainforestCli::OptionParser do
       its(:import_name) { should == 'some_name' }
     end
 
+    context 'app_source_url' do
+      let(:args) { ['--app-source-url', 'some_app'] }
+      its(:app_source_url) { should == 'some_app' }
+    end
+
     context 'run all tests' do
       let(:args) { ['run', 'all'] }
       its(:tests) { should == ['all']}

data/spec/rainforest-example/example_test.rfml

@@ -1,6 +1,7 @@
 #! 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.

data/spec/redirection-examples/no_redirect.rfml

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

data/spec/redirection-examples/no_redirect_embedded.rfml

@@ -0,0 +1,10 @@
+#! example_test
+# title: Example Test
+# tags: foo,bar,baz
+# start_uri: /start_uri
+
+This is a step action.
+This is a question?
+
+# redirect: false 
+- another_test

data/spec/redirection-examples/redirect.rfml

@@ -0,0 +1,10 @@
+#! example_test
+# title: Example Test
+# tags: foo,bar,baz
+# start_uri: /start_uri
+
+- another_test
+
+# redirect: true
+This is a step action.
+This is a question?

data/spec/redirection-examples/redirect_embedded.rfml

@@ -0,0 +1,10 @@
+#! example_test
+# title: Example Test
+# tags: foo,bar,baz
+# start_uri: /start_uri
+
+This is a step action.
+This is a question?
+
+# redirect: true
+- another_test

data/spec/redirection-examples/wrong_redirect.rfml

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