rainforest-cli 1.2.0 → 1.2.1

data/spec/spec_helper.rb

@@ -1,16 +1,11 @@
-# This file was generated by the `rspec --init` command. Conventionally, all
-# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
-# Require this file using `require "spec_helper"` to ensure that it is only
-# loaded once.
-#
-# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
-
-require "rainforest/cli"
+# frozen_string_literal: true
+require 'rspec/its'
+require 'byebug'
+require 'rainforest/cli'
 
 RainforestCli.logger = Logger.new(StringIO.new)
 
 RSpec.configure do |config|
-  config.treat_symbols_as_metadata_keys_with_true_values = true
   config.run_all_when_everything_filtered = true
   config.filter_run :focus
 
@@ -20,3 +15,15 @@ RSpec.configure do |config|
   #     --seed 1234
   config.order = 'random'
 end
+
+RSpec::Matchers.define :test_with_file_name do |expected_name|
+  match do |actual|
+    actual.file_name == expected_name
+  end
+end
+
+RSpec::Matchers.define :array_excluding do |expected_exclusion|
+  match do |actual|
+    !actual.include?(expected_exclusion)
+  end
+end

data/spec/test_files_spec.rb

@@ -1,36 +1,32 @@
+# frozen_string_literal: true
 describe RainforestCli::TestFiles do
-  let(:test_folder) { File.dirname(__FILE__) + '/rainforest-example' }
-  subject { described_class.new(test_folder) }
+  describe '#test_data' do
+    let(:test_folder) { File.dirname(__FILE__) + '/rainforest-example' }
+    subject { described_class.new(test_folder) }
 
-  let(:rfml_test) { subject.test_data.first }
-  let(:text_file) { File.read(test_folder + '/example_test.rfml') }
+    let(:rfml_test) { subject.test_data.first }
+    let(:text_file) { File.read(test_folder + '/example_test.rfml') }
 
-  describe '#initialize' do
-    before do
-      allow(Dir).to receive(:mkdir)
+    it 'parses all available tests on initialization' do
+      expect(rfml_test.title).to eq(text_file.match(/^# title: (.+)$/)[1])
+      expect(rfml_test.rfml_id).to eq(text_file.match(/^#! (.+?)($| .+?$)/)[1])
     end
+  end
 
-    context 'when test folder name is not supplied' do
-      it 'uses the default file folder' do
-        expect(described_class.new.test_folder).to eq(described_class::DEFAULT_TEST_FOLDER)
-      end
-    end
+  describe '#test_dictionary' do
+    Test = Struct.new(:rfml_id, :id)
 
-    context 'when test folder name is supplied' do
-      let(:folder_name) { './foo' }
+    subject { described_class.new }
+    let(:tests) { [Test.new('foo', 123), Test.new('bar', 456), Test.new('baz', 789)] }
 
-      it 'creates the supplied folder if file does not exist' do
-        expect(Dir).to receive(:mkdir).with(folder_name).once
-        described_class.new(folder_name)
-      end
+    before do
+      allow(FileUtils).to receive(:mkdir_p)
+      allow_any_instance_of(described_class).to receive(:test_data)
+        .and_return(tests)
     end
 
-  end
-
-  describe '#test_data' do
-    it 'parses all available tests on initialization' do
-      expect(rfml_test.title).to eq(text_file.match(/^# title: (.+)$/)[1])
-      expect(rfml_test.rfml_id).to eq(text_file.match(/^#! (.+?)($| .+?$)/)[1])
+    it "correctly formats the dictionary's keys and values" do
+      expect(subject.test_dictionary).to include({})
     end
   end
 end

data/spec/uploader_spec.rb

@@ -0,0 +1,54 @@
+# 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({})
+  end
+
+  describe '#upload' do
+    context 'with new tests' do
+      let(:test_directory) { File.expand_path(File.join(__FILE__, '../validation-examples/correct_embeds')) }
+      let(:rf_test_double) { instance_double('Rainforest::Test', id: 123) }
+
+      before do
+        allow(subject).to receive(:upload_test)
+      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))
+          .and_return(rf_test_double).twice
+        subject.upload
+      end
+    end
+  end
+
+  describe 'uploaded test object' do
+    let(:test_directory) { File.expand_path(File.join(__FILE__, '../rainforest-example')) }
+    let(:test_double) { instance_double('Rainforest::Test', id: 123) }
+
+    before do
+      allow(Rainforest::Test).to receive(:create).and_return(test_double)
+    end
+
+    it 'contains the correct attributes' do
+      expect(Rainforest::Test).to receive(:update) do |_id, test_attrs|
+        expect(test_attrs).to include({
+                                        start_uri: '/start_uri',
+                                        title: 'Example Test',
+                                        source: 'rainforest-cli',
+                                        tags: ['foo', 'bar', 'baz'],
+                                        rfml_id: 'example_test'
+                                      })
+      end
+
+      subject.upload
+    end
+  end
+end

data/spec/validation-examples/circular_embeds/test1.rfml

@@ -0,0 +1,5 @@
+#! test1
+# title: Test 1
+# start_uri: /
+
+- test2

data/spec/validation-examples/circular_embeds/test2.rfml

@@ -0,0 +1,5 @@
+#! test2
+# title: Test 2
+# start_uri: /
+
+- test1

data/spec/validation-examples/correct_embeds/embedded_test.rfml

@@ -0,0 +1,6 @@
+#! embedded_test
+# title: Embedded Test
+# start_uri: /
+
+Embedded action
+Embedded question?

data/spec/validation-examples/correct_embeds/test_with_embedded.rfml

@@ -0,0 +1,8 @@
+#! 08751893-89af-4235-9a1a-1b1a809d05c8
+# title: Test with Embedded
+# start_uri: /
+
+- embedded_test
+
+Parent test
+Parent test?

data/spec/validation-examples/missing_embeds/correct_test.rfml

@@ -0,0 +1,8 @@
+#! correct_test
+# title: New Test 2
+# start_uri: /
+
+Action
+Question?
+
+- parent

data/spec/validation-examples/missing_embeds/incorrect_test.rfml

@@ -0,0 +1,8 @@
+#! parent
+# title: New test
+# start_uri: /
+
+Action
+Question?
+
+- non_existent_embed

data/spec/validation-examples/parse_errors/no_parse_errors.rfml

@@ -0,0 +1,6 @@
+#! no_parse_errors
+# title: No Parse Errors Test
+# start_uri: /
+
+Nothing wrong with this action!
+Nothing wrong with this question?

data/spec/validation-examples/parse_errors/no_question.rfml

@@ -0,0 +1,5 @@
+#! no_question_test
+# title: No Question Test
+# start_uri: /
+
+This is an action without a question.

data/spec/validation-examples/parse_errors/no_question_mark.rfml

@@ -0,0 +1,6 @@
+#! no_question_mark_test
+# title: No Question Mark Test
+# start_uri: /
+
+This is an action with a question.
+This is a question without a question mark

data/spec/validation-examples/parse_errors/no_rfml_id.rfml

@@ -0,0 +1,5 @@
+# title: No RFML ID Test
+# start_uri: /
+
+This is an action.
+This is a question.

data/spec/validator_spec.rb

@@ -0,0 +1,119 @@
+# 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
+    expect(subject).to receive(notification_method)
+      .with(array_including(test_with_file_name(file_path)))
+      .and_call_original
+
+    if raises_error
+      expect { subject.public_send(tested_method) }.to raise_error(SystemExit)
+    else
+      expect { subject.public_send(tested_method) }.to_not raise_error
+    end
+  end
+
+  def does_not_notify_for_wrong_file_names
+    expect(subject).to receive(notification_method)
+      .with(array_excluding(test_with_file_name(file_path)))
+      .and_call_original
+
+    if raises_error
+      expect { subject.public_send(tested_method) }.to raise_error(SystemExit)
+    else
+      expect { subject.public_send(tested_method) }.to_not raise_error
+    end
+  end
+
+  shared_examples 'it detects all the correct errors' do
+    let(:options) { instance_double('RainforestCli::Options', test_folder: test_directory, token: 'api_token') }
+    subject { described_class.new(options) }
+
+    before do
+      allow(Rainforest::Test).to receive(:all).and_return([])
+    end
+
+    context 'with parsing errors' do
+      let(:notification_method) { :parsing_error_notification }
+      let(:test_directory) { File.expand_path(File.join(__FILE__, '../validation-examples/parse_errors')) }
+
+      context 'no rfml id' do
+        let(:correct_file_name) { 'no_rfml_id.rfml' }
+        it { notifies_with_correct_file_name }
+      end
+
+      context 'no question' do
+        let(:correct_file_name) { 'no_rfml_id.rfml' }
+        it { notifies_with_correct_file_name }
+      end
+
+      context 'no question mark' do
+        let(:correct_file_name) { 'no_question_mark.rfml' }
+        it { notifies_with_correct_file_name }
+      end
+
+      context 'no parse errors' do
+        let(:correct_file_name) { 'no_question_mark.rfml' }
+        it { does_not_notify_for_wrong_file_names }
+      end
+    end
+
+    context 'with a incorrect embedded RFML ID' do
+      let(:notification_method) { :nonexisting_embedded_id_notification }
+      let(:test_directory) { File.expand_path(File.join(__FILE__, '../validation-examples/missing_embeds')) }
+
+      context 'the file containing in the incorrect id' do
+        let(:correct_file_name) { 'incorrect_test.rfml' }
+        it { notifies_with_correct_file_name }
+      end
+
+      context 'the file with the correct id' do
+        let(:correct_file_name) { 'correct_test.rfml' }
+        it { does_not_notify_for_wrong_file_names }
+      end
+    end
+
+    context 'with circular embeds' do
+      let(:test_directory) { File.expand_path(File.join(__FILE__, '../validation-examples/circular_embeds')) }
+      let(:file_name_a) { File.join(test_directory, 'test1.rfml') }
+      let(:file_name_b) { File.join(test_directory, 'test2.rfml') }
+
+      it 'raises a CircularEmbeds error for both tests' do
+        expect(subject).to receive(:circular_dependencies_notification) do |a, b|
+          expect([a, b] - [file_name_a, file_name_b]).to be_empty
+        end.and_call_original
+
+        expect { subject.validate_with_exception! }.to raise_error(SystemExit)
+      end
+    end
+  end
+
+  describe '#validate' do
+    let(:tested_method) { :validate }
+    let(:raises_error) { false }
+
+    it_behaves_like 'it detects all the correct errors'
+  end
+
+  describe '#validate_with_exception!' do
+    let(:tested_method) { :validate_with_exception! }
+    let(:raises_error) { true }
+
+    it_behaves_like 'it detects all the correct errors'
+
+    context 'without a token option' do
+      let(:test_directory) { File.expand_path(File.join(__FILE__, '../validation-examples')) }
+      let(:options) { instance_double('RainforestCli::Options', test_folder: test_directory, token: nil) }
+      subject { described_class.new(options) }
+
+      it 'validates locally and tells the user to include a token to valid with server tests as well' do
+        expect_any_instance_of(Logger).to receive(:error).with(described_class::API_TOKEN_ERROR)
+
+        expect { subject.validate_with_exception! }.to raise_error(SystemExit)
+      end
+    end
+  end
+end

metadata

@@ -1,72 +1,110 @@
 --- !ruby/object:Gem::Specification
 name: rainforest-cli
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.1
 platform: ruby
 authors:
-- Simon Mathieu
 - Russell Smith
+- Edward Paulet
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-09 00:00:00.000000000 Z
+date: 2016-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.13.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.13.7
 - !ruby/object:Gem::Dependency
   name: parallel
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.6.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.6.1
 - !ruby/object:Gem::Dependency
   name: ruby-progressbar
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.7.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.7.5
 - !ruby/object:Gem::Dependency
   name: rainforest
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: http-exceptions
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.4
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -85,20 +123,26 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 10.4.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 10.4.2
 description: Command line utility for Rainforest QA
 email:
-- simon@rainforestqa.com
 - russ@rainforestqa.com
+- edward@rainforestqa.com
 executables:
 - rainforest
 extensions: []
@@ -107,6 +151,8 @@ files:
 - ".gitignore"
 - ".gitmodules"
 - ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
 - ".rvmrc"
 - ".travis.yml"
 - CHANGELOG.md
@@ -115,26 +161,45 @@ 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/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/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
 - lib/rainforest/cli/version.rb
 - rainforest-cli.gemspec
 - spec/cli_spec.rb
 - spec/csv_importer_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/remote_tests_spec.rb
 - spec/runner_spec.rb
 - spec/spec_helper.rb
 - spec/test_files_spec.rb
+- spec/uploader_spec.rb
+- spec/validation-examples/circular_embeds/test1.rfml
+- 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/missing_embeds/correct_test.rfml
+- spec/validation-examples/missing_embeds/incorrect_test.rfml
+- spec/validation-examples/parse_errors/no_parse_errors.rfml
+- spec/validation-examples/parse_errors/no_question.rfml
+- spec/validation-examples/parse_errors/no_question_mark.rfml
+- spec/validation-examples/parse_errors/no_rfml_id.rfml
+- spec/validator_spec.rb
 homepage: https://www.rainforestqa.com/
 licenses:
 - MIT
@@ -164,8 +229,23 @@ test_files:
 - spec/csv_importer_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/remote_tests_spec.rb
 - spec/runner_spec.rb
 - spec/spec_helper.rb
 - spec/test_files_spec.rb
+- spec/uploader_spec.rb
+- spec/validation-examples/circular_embeds/test1.rfml
+- 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/missing_embeds/correct_test.rfml
+- spec/validation-examples/missing_embeds/incorrect_test.rfml
+- spec/validation-examples/parse_errors/no_parse_errors.rfml
+- spec/validation-examples/parse_errors/no_question.rfml
+- spec/validation-examples/parse_errors/no_question_mark.rfml
+- spec/validation-examples/parse_errors/no_rfml_id.rfml
+- spec/validator_spec.rb
+has_rdoc: