rainforest-cli 1.2.2 → 1.3.0

data/spec/redirection-examples/wrong_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: foo
+- another_test

data/spec/redirection-examples/wrong_redirect_spacing.rfml

@@ -0,0 +1,11 @@
+#! 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: true
+
+This is a step action.
+This is a question?

data/spec/sites_spec.rb

@@ -0,0 +1,74 @@
+# 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

data/spec/spec_helper.rb

@@ -13,6 +13,13 @@ RSpec.configure do |config|
   # the seed, which is printed after each run.
   #     --seed 1234
   config.order = 'random'
+
+  config.before do
+    progressbar_mock = double('ProgressBar')
+    allow(ProgressBar).to receive(:create).and_return(progressbar_mock)
+    allow(progressbar_mock).to receive(:increment)
+    ENV['RAINFOREST_API_TOKEN'] = nil
+  end
 end
 
 RSpec::Matchers.define :test_with_file_name do |expected_name|

data/spec/test_files_spec.rb

@@ -1,11 +1,12 @@
 # frozen_string_literal: true
 describe RainforestCli::TestFiles do
   describe '#test_data' do
-    let(:test_folder) { File.dirname(__FILE__) + '/rainforest-example' }
-    subject { described_class.new(test_folder) }
+    let(:test_directory) { File.dirname(__FILE__) + '/rainforest-example' }
+    let(:options) { instance_double('RainforestCli::Options', test_folder: test_directory) }
+    subject { described_class.new(options) }
 
     let(:rfml_test) { subject.test_data.first }
-    let(:text_file) { File.read(test_folder + '/example_test.rfml') }
+    let(:text_file) { File.read(test_directory + '/example_test.rfml') }
 
     it 'parses all available tests on initialization' do
       expect(rfml_test.title).to eq(text_file.match(/^# title: (.+)$/)[1])
@@ -16,7 +17,8 @@ describe RainforestCli::TestFiles do
   describe '#test_dictionary' do
     Test = Struct.new(:rfml_id, :id)
 
-    subject { described_class.new }
+    let(:options) { instance_double('RainforestCli::Options', test_folder: nil) }
+    subject { described_class.new(options) }
     let(:tests) { [Test.new('foo', 123), Test.new('bar', 456), Test.new('baz', 789)] }
 
     before do

data/spec/test_parser_spec.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+describe RainforestCli::TestParser do
+  describe RainforestCli::TestParser::Step do
+    describe '#to_element' do
+      subject { described_class.new('action', 'response', 'redirect').to_element }
+      its([:redirection]) { is_expected.to eq('redirect') }
+
+      context 'with no redirect' do
+        subject { described_class.new('action', 'response', nil).to_element }
+        its([:redirection]) { is_expected.to eq('true') }
+      end
+    end
+  end
+
+  describe RainforestCli::TestParser::EmbeddedTest do
+    describe '#to_element' do
+      let(:primary_key_id) { 123 }
+      subject { described_class.new.to_element(primary_key_id) }
+
+      context 'with no redirect' do
+        its([:redirection]) { is_expected.to eq('true') }
+      end
+    end
+  end
+
+  describe RainforestCli::TestParser::Parser do
+    subject { described_class.new(file_name) }
+
+    describe '#process' do
+      context 'redirection' do
+        context 'step' do
+          context 'no redirection specified' do
+            let(:file_name) { File.dirname(__FILE__) + '/rainforest-example/example_test.rfml' }
+            it { has_redirection_value(subject.process, 'true') }
+          end
+
+          context 'redirection specified as true' do
+            let(:file_name) { File.dirname(__FILE__) + '/redirection-examples/redirect.rfml' }
+            it { has_redirection_value(subject.process, 'true') }
+          end
+
+          context 'redirection specified as not true or false' do
+            let(:file_name) { File.dirname(__FILE__) + '/redirection-examples/wrong_redirect.rfml' }
+            let(:redirect_line_no) { 7 }
+            it { has_parsing_error(subject.process, redirect_line_no) }
+          end
+        end
+
+        context 'embedded test' do
+          context 'redirection specified as false' do
+            let(:file_name) { File.dirname(__FILE__) + '/redirection-examples/no_redirect_embedded.rfml' }
+            it { has_redirection_value(subject.process, 'false') }
+          end
+
+          context 'redirection specified as true' do
+            let(:file_name) { File.dirname(__FILE__) + '/redirection-examples/redirect_embedded.rfml' }
+            it { has_redirection_value(subject.process, 'true') }
+          end
+
+          context 'redirection specified as not true or false' do
+            let(:file_name) { File.dirname(__FILE__) + '/redirection-examples/wrong_redirect_embedded.rfml' }
+            let(:redirect_line_no) { 8 }
+            it { has_parsing_error(subject.process, redirect_line_no) }
+          end
+        end
+
+        context 'poor syntax' do
+          context 'extra empty lines' do
+            let(:file_name) { File.dirname(__FILE__) + '/redirection-examples/wrong_redirect_spacing.rfml' }
+            let(:empty_line_no) { 8 }
+            it { has_parsing_error(subject.process, empty_line_no) }
+          end
+        end
+
+        def has_redirection_value(test, value)
+          step = test.steps.last
+          expect(step.redirection).to eq(value)
+        end
+
+        def has_parsing_error(test, line_no)
+          expect(test.errors[line_no]).to_not be_nil
+        end
+      end
+    end
+  end
+end

data/spec/uploader_spec.rb

@@ -1,12 +1,9 @@
 # frozen_string_literal: true
 describe RainforestCli::Uploader do
   let(:options) { instance_double('RainforestCli::Options', token: 'foo', test_folder: test_directory) }
-  let(:progress_bar_double) { double('ProgressBar') }
   subject { described_class.new(options) }
 
   before do
-    allow(ProgressBar).to receive(:create).and_return(progress_bar_double)
-    allow(progress_bar_double).to receive(:increment)
     allow_any_instance_of(RainforestCli::Validator).to receive(:validate_with_exception!)
     allow_any_instance_of(RainforestCli::RemoteTests).to receive(:primary_key_dictionary)
       .and_return({})
@@ -22,7 +19,7 @@ describe RainforestCli::Uploader do
       end
 
       it 'creates uploads the new tests with no steps' do
-        expect(Rainforest::Test).to receive(:create).with(hash_including(:title, :start_uri, :rfml_id))
+        expect(Rainforest::Test).to receive(:create).with(hash_including(:title, :start_uri, :rfml_id, :source))
           .and_return(rf_test_double).twice
         subject.upload
       end
@@ -44,7 +41,8 @@ describe RainforestCli::Uploader do
                                         title: 'Example Test',
                                         source: 'rainforest-cli',
                                         tags: ['foo', 'bar', 'baz'],
-                                        rfml_id: 'example_test'
+                                        rfml_id: 'example_test',
+                                        site_id: '456'
                                       })
       end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rainforest-cli
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 1.3.0
 platform: ruby
 authors:
 - Russell Smith
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-21 00:00:00.000000000 Z
+date: 2016-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -161,17 +161,17 @@ files:
 - README.md
 - Rakefile
 - bin/rainforest
-- circle.yml
 - lib/rainforest/cli.rb
 - lib/rainforest/cli/constants.rb
 - lib/rainforest/cli/csv_importer.rb
+- lib/rainforest/cli/exporter.rb
 - lib/rainforest/cli/git_trigger.rb
 - lib/rainforest/cli/http_client.rb
 - lib/rainforest/cli/options.rb
 - lib/rainforest/cli/remote_tests.rb
 - lib/rainforest/cli/runner.rb
+- lib/rainforest/cli/sites.rb
 - lib/rainforest/cli/test_files.rb
-- lib/rainforest/cli/test_importer.rb
 - lib/rainforest/cli/test_parser.rb
 - lib/rainforest/cli/uploader.rb
 - lib/rainforest/cli/validator.rb
@@ -179,15 +179,25 @@ files:
 - rainforest-cli.gemspec
 - spec/cli_spec.rb
 - spec/csv_importer_spec.rb
+- spec/exporter_spec.rb
 - spec/fixtures/variables.txt
 - spec/git_trigger_spec.rb
 - spec/http_client_spec.rb
 - spec/options_spec.rb
 - spec/rainforest-example/example_test.rfml
+- spec/redirection-examples/no_redirect.rfml
+- spec/redirection-examples/no_redirect_embedded.rfml
+- spec/redirection-examples/redirect.rfml
+- spec/redirection-examples/redirect_embedded.rfml
+- spec/redirection-examples/wrong_redirect.rfml
+- spec/redirection-examples/wrong_redirect_embedded.rfml
+- spec/redirection-examples/wrong_redirect_spacing.rfml
 - spec/remote_tests_spec.rb
 - spec/runner_spec.rb
+- spec/sites_spec.rb
 - spec/spec_helper.rb
 - spec/test_files_spec.rb
+- spec/test_parser_spec.rb
 - spec/uploader_spec.rb
 - spec/validation-examples/circular_embeds/test1.rfml
 - spec/validation-examples/circular_embeds/test2.rfml
@@ -227,15 +237,25 @@ summary: Command line utility for Rainforest QA
 test_files:
 - spec/cli_spec.rb
 - spec/csv_importer_spec.rb
+- spec/exporter_spec.rb
 - spec/fixtures/variables.txt
 - spec/git_trigger_spec.rb
 - spec/http_client_spec.rb
 - spec/options_spec.rb
 - spec/rainforest-example/example_test.rfml
+- spec/redirection-examples/no_redirect.rfml
+- spec/redirection-examples/no_redirect_embedded.rfml
+- spec/redirection-examples/redirect.rfml
+- spec/redirection-examples/redirect_embedded.rfml
+- spec/redirection-examples/wrong_redirect.rfml
+- spec/redirection-examples/wrong_redirect_embedded.rfml
+- spec/redirection-examples/wrong_redirect_spacing.rfml
 - spec/remote_tests_spec.rb
 - spec/runner_spec.rb
+- spec/sites_spec.rb
 - spec/spec_helper.rb
 - spec/test_files_spec.rb
+- spec/test_parser_spec.rb
 - spec/uploader_spec.rb
 - spec/validation-examples/circular_embeds/test1.rfml
 - spec/validation-examples/circular_embeds/test2.rfml

data/circle.yml

@@ -1,3 +0,0 @@
-test:
-  pre:
-    - bundle exec circlemator style-check --base-branch=master

data/lib/rainforest/cli/test_importer.rb

@@ -1,182 +0,0 @@
-# frozen_string_literal: true
-require 'securerandom'
-require 'rainforest'
-require 'parallel'
-require 'ruby-progressbar'
-
-class RainforestCli::TestImporter
-  attr_reader :options, :client, :test_files
-
-  SAMPLE_FILE = <<EOF
-#! %s (Test ID - only edit if this test has not yet been uploaded)
-# title: New test
-# start_uri: /
-#
-# Lines starting with # are test attributes or comments
-# Possible attributes: #{RainforestCli::TestParser::Parser::TEXT_FIELDS.join(', ')}
-#
-# Steps are composed of two lines: an action and a question. Example:
-#
-# This is the step action.
-# This is the step question?
-#
-
-EOF
-
-  def initialize(options)
-    @options = options
-    ::Rainforest.api_key = @options.token
-    @test_files = RainforestCli::TestFiles.new(@options.test_folder)
-  end
-
-  def logger
-    RainforestCli.logger
-  end
-
-  def threads
-    RainforestCli::THREADS
-  end
-
-  def export
-    tests = Rainforest::Test.all(page_size: 1000)
-    p = ProgressBar.create(title: 'Rows', total: tests.count, format: '%a %B %p%% %t')
-    Parallel.each(tests, in_threads: threads, finish: lambda { |_item, _i, _result| p.increment }) do |test|
-
-      # File name
-      file_name = sprintf('%010d', test.id) + '_' + test.title.strip.gsub(/[^a-z0-9 ]+/i, '').gsub(/ +/, '_').downcase
-      file_name = create_new(file_name)
-      File.truncate(file_name, 0)
-
-      # Get the full test from the API
-      test = Rainforest::Test.retrieve(test.id)
-
-      File.open(file_name, 'a') do |file|
-        file.puts _get_header(test)
-
-        index = 0
-        test.elements.each do |element|
-          index = _process_element(file, element, index)
-        end
-      end
-    end
-  end
-
-  def _process_element file, element, index
-    case element[:type]
-    when 'test'
-      element[:element][:elements].each do |sub_element|
-        index = _process_element(file, sub_element, index)
-      end
-    when 'step'
-      file.puts '' unless index == 0
-      file.puts "# step #{index + 1}" if @options.debug
-      file.puts element[:element][:action]
-      file.puts element[:element][:response]
-    else
-      raise "Unknown element type: #{element[:type]}"
-    end
-
-    index += 1
-    index
-  end
-
-  # add comments if not already present
-  def _get_header test
-    out = []
-
-    has_id = false
-    test.description.to_s.strip.lines.map(&:chomp).each_with_index do |line, _line_no|
-      line = line.gsub(/\#+$/, '').strip
-
-      # make sure the test has an ID
-      has_id = true if line[0] == '!'
-
-      out << '#' + line
-    end
-
-    unless has_id
-      browsers = test.browsers.map {|b| b[:name] if b[:state] == 'enabled' }.compact
-      out = [
-        "#! #{SecureRandom.uuid}",
-        "# title: #{test.title}",
-        "# start_uri: #{test.start_uri}",
-        "# tags: #{test.tags.join(", ")}",
-        "# browsers: #{browsers.join(", ")}",
-        '#',
-        ' ',
-      ] + out
-    end
-
-    out.compact.join("\n")
-  end
-
-  def _get_id test
-    id = nil
-    test.description.to_s.strip.lines.map(&:chomp).each_with_index do |line, _line_no|
-      line = line.gsub(/\#+$/, '').strip
-      if line[0] == '!'
-        id = line[1..-1].split(' ').first
-        break
-      end
-    end
-    id
-  end
-
-  def validate
-    tests = {}
-    has_errors = []
-
-    Dir.glob(test_files.test_paths).each do |file_name|
-      out = RainforestCli::TestParser::Parser.new(file_name).process
-
-      tests[file_name] = out
-      has_errors << file_name if out.errors != {}
-    end
-
-    if !has_errors.empty?
-      logger.error 'Parsing errors:'
-      logger.error ''
-      has_errors.each do |file_name|
-        logger.error ' ' + file_name
-        tests[file_name].errors.each do |_line, error|
-          logger.error "\t#{error}"
-        end
-      end
-
-      exit 2
-    end
-
-    if @options.debug
-      tests.each do |file_name, test|
-        logger.debug test.inspect
-        logger.debug "#{file_name}"
-        logger.debug test.description
-        test.steps.each do |step|
-          logger.debug "\t#{step}"
-        end
-      end
-    else
-      logger.info '[VALID]'
-    end
-
-    return tests
-  end
-
-  def create_new file_name = nil
-    name = @options.file_name if @options.file_name
-    name = file_name if !file_name.nil?
-    ext = test_files.file_extension
-
-    uuid = SecureRandom.uuid
-    name = "#{uuid}#{ext}" unless name
-    name += ext unless name[-ext.length..-1] == ext
-
-    FileUtils.mkdir_p(test_files.test_folder) unless Dir.exist?(test_files.test_folder)
-    name = File.join([test_files.test_folder, name])
-
-    File.open(name, 'w') { |file| file.write(sprintf(SAMPLE_FILE, uuid)) }
-
-    logger.info "Created #{name}" if file_name.nil?
-    name
-  end
-end