rainforest-cli 1.5.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 854465637763f313d813365ea7996c8aa2d43808
-  data.tar.gz: 44115420d528b8ee03e501eba5fca683439aecca
+  metadata.gz: 572509cbd3863f100fbe585b1bef8cd87b1e6660
+  data.tar.gz: 9d1b997c421aee71f56fe5901d77c245d2291130
 SHA512:
-  metadata.gz: 6c8ed4a11a1bca3e2b58672f1ebaae2c3e12265d458107bd19082a193f44cc47bb22113c4d9714190e19bff7fa383ebab4d8cc4d5b260ffc28a3462c72dff957
-  data.tar.gz: 3a335dbc44d8a00c7910d5b1eabb66d6f25e0d7f4d4e9f982b2b246d8450ec78706c189afbbf817559d091eb613a81dc19f80a319b857289ae02848add661f32
+  metadata.gz: d3dea6785acb946d8882d5a7ef86bc49e0d3a8fbc95580838de499cee1690502e01c647bdcd696567210d4853fcb77e7d611b29e7e69b64390848c9910b2bcba
+  data.tar.gz: 1fde1d05b2894bc0fca33fe018c38afd8469828f29e31416316e9d21fa1f04f04b217a932e2eb03303f345ac18a1aefff8c613f4b80cbf0d833cd4b9a7680b6e

data/CHANGELOG.md

@@ -1,12 +1,20 @@
 # Rainforest CLI Changelog
 
-## 1.5.0
+## 1.6.0 - 8th June 2016
+- Add `rm` command to delete tests. (cf077bd440e83852d8d23f66eb72ba94fece0c07, @marktran)
+- New tests use title given when created using `rainforest new [TEST_NAME]`.
+(01e30ba9d97558ba11c239a5c9842192d38dfd3f, @epaulet)
+- Remove static browser list and stop client side validation of browsers for run
+creation. Allow the API to validate against the dynamic list of client browsers
+instead. (48a4d11e524d020e78e14991bf8a0c5bf82b65c9, @epaulet)
+
+## 1.5.0 - 23rd May 2016
 - Retry on API exceptions when creating a run. (85830adcef426e64bd72c9d6208881e955a5bb0c, @bbeck)
 - Add `browsers` command. (2a810ec27edfc66ef7bf27d8cb7da1129b05e32b, @epaulet)
 - Add support for files using `app-source-url`. (562e4772e71e8028209d128091ff644f4ae0a9f6, @marianafranco)
 - Remove newlines from test actions and questions when exporting. (e28583b553b5f30b33b232b2e377c109123b11ff, @epaulet)
 
-## 1.4.0
+## 1.4.0 - 22nd April 2016
 - Support for new `--version` command. (4362c85fe599a02eaa1b772d184be31e692e934e, @epaulet)
 - Validate duplicate RFML IDs before uploading. (67f71d053c755eaf92c1bd205931e89e903b88c9, @curtis-rainforestqa)
 - Add `folders` commands for a folder ID reference. (4ab19fec0924b4764e140fb3c5aa85f1dbfe4006, @epaulet)

data/README.md

@@ -51,6 +51,12 @@ Create new Rainforest test in RFML format (Rainforest Markup Language).
 rainforest new
 ```
 
+You may also specify a custom test title or file name.
+
+```bash
+rainforest new "My Awesome Title"
+```
+
 Upload tests to Rainforest
 
 ```bash

data/lib/rainforest/cli.rb

@@ -14,6 +14,7 @@ require 'rainforest/cli/test_files'
 require 'rainforest/cli/remote_tests'
 require 'rainforest/cli/validator'
 require 'rainforest/cli/exporter'
+require 'rainforest/cli/deleter'
 require 'rainforest/cli/uploader'
 require 'rainforest/cli/resources'
 
@@ -34,6 +35,7 @@ module RainforestCli
     when 'new' then TestFiles.new(options).create_file
     when 'validate' then Validator.new(options).validate
     when 'upload' then Uploader.new(options).upload
+    when 'rm' then Deleter.new(options).delete
     when 'export' then Exporter.new(options).export
     when 'sites', 'folders', 'browsers'
       Resources.new(options).public_send(options.command)

data/lib/rainforest/cli/deleter.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+require 'rainforest'
+
+class RainforestCli::Deleter
+  attr_reader :test_files, :remote_tests
+
+  def initialize(options)
+    @file_name = options.file_name
+    @test_files = RainforestCli::TestFiles.new(options)
+    @remote_tests = RainforestCli::RemoteTests.new(options.token)
+  end
+
+  def delete
+    validate_file_extension
+    delete_remote_test(test_file)
+    delete_local_file(test_file.file_name)
+  end
+
+  private
+
+  def validate_file_extension
+    if !rfml_extension?
+      logger.fatal "Error: file extension must be .rfml"
+      exit 2
+    end
+  end
+
+  def rfml_extension?
+    extname = File.extname(@file_name)
+    RainforestCli::TestFiles::FILE_EXTENSION == extname
+  end
+
+  def delete_local_file(path_to_file)
+    File.delete(path_to_file)
+  end
+
+  def delete_remote_test(rfml_test)
+    Rainforest::Test.delete(primary_key_dictionary[rfml_test.rfml_id])
+  rescue Exception => e
+    logger.fatal "Unable to delete remote rfml test"
+    exit 2
+  end
+
+  def test_file
+    @test_file ||= rfml_tests.detect do |rfml_test|
+      rfml_test.file_name == @file_name
+    end
+  end
+
+  def rfml_tests
+    @rfml_tests ||= test_files.test_data
+  end
+
+  def primary_key_dictionary
+    @primary_key_dictionary ||= remote_tests.primary_key_dictionary
+  end
+
+  def logger
+    RainforestCli.logger
+  end
+end

data/lib/rainforest/cli/options.rb

@@ -8,39 +8,6 @@ module RainforestCli
                 :import_file_name, :import_name, :custom_url, :description, :folder,
                 :debug, :file_name, :test_folder, :embed_tests, :app_source_url, :crowd
 
-    # Note, not all of these may be available to your account
-    # also, we may remove this in the future.
-    VALID_BROWSERS = %w{
-      android_phone_landscape
-      android_phone_portrait
-      android_tablet_landscape
-      android_tablet_portrait
-      chrome
-      chrome_1440_900
-      chrome_adblock
-      chrome_ghostery
-      chrome_guru
-      chrome_ublock
-      firefox
-      firefox_1440_900
-      ie10
-      ie10_1440_900
-      ie11
-      ie11_1440_900
-      ie8
-      ie8_1440_900
-      ie9
-      ie9_1440_900
-      ios_iphone4s
-      office2010
-      office2013
-      osx_chrome
-      osx_firefox
-      safari
-      ubuntu_chrome
-      ubuntu_firefox
-      iphone_6s_v9_0
-    }.freeze
     TOKEN_NOT_REQUIRED = %w{new validate}.freeze
 
     def initialize(args)
@@ -152,8 +119,12 @@ module RainforestCli
 
       @command = @args.shift
 
-      if @command == 'new'
+      if ['new', 'rm'].include?(@command)
         @file_name = @args.shift
+
+        if @file_name && @command == 'rm'
+          @file_name = File.expand_path(@file_name) if @file_name
+        end
       end
 
       @tests = @args.dup
@@ -182,10 +153,6 @@ module RainforestCli
         end
       end
 
-      if browsers
-        raise BrowserException, browsers unless (browsers - VALID_BROWSERS).empty?
-      end
-
       if custom_url && site_id.nil?
         raise ValidationError, 'The site-id and custom-url options are both required.'
       end
@@ -194,21 +161,18 @@ module RainforestCli
         unless File.exist?(import_file_name)
           raise ValidationError, "Input file: #{import_file_name} not found"
         end
-
       elsif import_file_name || import_name
         raise ValidationError, 'You must pass both --import-variable-csv-file and --import-variable-name'
       end
+
+      if command == 'rm' && file_name.nil?
+        raise ValidationError, 'You must include a file name'
+      end
+
       true
     end
 
     class ValidationError < RuntimeError
     end
-
-    class BrowserException < ValidationError
-      def initialize browsers
-        invalid_browsers = browsers - OptionParser::VALID_BROWSERS
-        super "#{invalid_browsers.join(', ')} is not valid. Valid browsers: #{OptionParser::VALID_BROWSERS.join(', ')}"
-      end
-    end
   end
 end

data/lib/rainforest/cli/test_files.rb

@@ -4,7 +4,7 @@ class RainforestCli::TestFiles
   FILE_EXTENSION = '.rfml'
   SAMPLE_FILE = <<EOF
 #! %s
-# title: New test
+# title: %s
 # start_uri: /
 # tags: rfml-test
 #
@@ -21,7 +21,10 @@ EOF
 
   def initialize(options)
     @options = options
-    if @options.test_folder.nil?
+
+    if @options.command == 'rm'
+      @test_folder = File.dirname(@options.file_name)
+    elsif @options.test_folder.nil?
       logger.info "No test folder supplied. Using default folder: #{DEFAULT_TEST_FOLDER}"
       @test_folder = File.expand_path(DEFAULT_TEST_FOLDER)
     else
@@ -70,20 +73,38 @@ EOF
   def create_file(file_name = @options.file_name)
     ensure_directory_exists
 
-    uuid = SecureRandom.uuid
+    title = file_name || 'Unnamed Test'
+    file_path = title.dup
 
-    name = file_name || uuid.to_s
-    name += file_extension unless name[-file_extension.length..-1] == file_extension
-    name = File.join(test_folder, name)
+    if title[-file_extension.length..-1] == file_extension
+      title = title[0...-file_extension.length]
+    else
+      file_path += file_extension
+    end
 
-    File.open(name, 'w') { |file| file.write(sprintf(SAMPLE_FILE, uuid)) }
+    file_path = unique_path(File.join(test_folder, file_path))
 
-    logger.info "Created #{name}"
-    name
+    File.open(file_path, 'w') { |file| file.write(sprintf(SAMPLE_FILE, SecureRandom.uuid, title)) }
+
+    logger.info "Created #{file_path}"
+    file_path
   end
 
   private
 
+  def unique_path(file_path)
+    path = file_path[0...-file_extension.length]
+    identifier = 0
+
+    loop do
+      id_string = (identifier > 0) ? " (#{identifier})" : ''
+      test_path = path + id_string + file_extension
+
+      return test_path unless File.exist?(test_path)
+      identifier += 1
+    end
+  end
+
   def logger
     RainforestCli.logger
   end

data/lib/rainforest/cli/test_parser.rb

@@ -79,7 +79,7 @@ module RainforestCli::TestParser
       @text = File.read(file_name).to_s
 
       @test = Test.new
-      @test.file_name = file_name
+      @test.file_name = File.expand_path(file_name)
       @test.description = ''
       @test.steps = []
       @test.errors = {}

data/lib/rainforest/cli/version.rb

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

data/spec/deleter_spec.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+describe RainforestCli::Deleter do
+  let(:options) do
+    instance_double(
+      'RainforestCli::Options',
+      token: 'foo',
+      test_folder: test_directory,
+      command: 'rm',
+      file_name: file_name
+    )
+  end
+
+  let(:test_directory) do
+    File.expand_path(File.join(__FILE__, '../validation-examples/correct-embeds'))
+  end
+
+  before(:each) do
+    allow(File).to receive(:delete)
+  end
+
+  subject { described_class.new(options) }
+
+  describe '#delete' do
+    context 'with incorrect file extension' do
+      let(:file_name) { 'embedded_test' }
+
+      it 'exits with the correct error' do
+        begin
+          expect_any_instance_of(
+            Logger
+          ).to receive(:fatal).with('Error: file extension must be .rfml')
+
+          subject.delete
+        rescue SystemExit => exception
+          expect(exception.status).to eq(2)
+        end
+      end
+    end
+
+    context 'with correct file extension' do
+      let(:file_name) { 'embedded_test.rfml' }
+      let(:rfml_id) { 'embedded_test' }
+      let(:test_id) { 25 }
+      let(:primary_key_dictionary) { Hash[rfml_id, test_id] }
+      let(:test_data) do
+        [instance_double(RainforestCli::TestParser::Test, file_name: file_name, rfml_id: rfml_id)]
+      end
+
+      context 'with remote rfml test' do
+        before do
+          allow_any_instance_of(RainforestCli::RemoteTests)
+            .to receive(:primary_key_dictionary).and_return(primary_key_dictionary)
+          allow_any_instance_of(RainforestCli::TestFiles)
+            .to receive(:test_data).and_return(test_data)
+        end
+
+        it 'deletes the remote rfml test' do
+          expect(Rainforest::Test).to receive(:delete).with(test_id)
+          # make sure that we don't reach SystemExit lines of file
+          expect { subject.delete }.to_not raise_error
+        end
+
+        it 'deletes the local file' do
+          allow(Rainforest::Test).to receive(:delete).with(test_id).and_return({})
+          expect(File).to receive(:delete).with(file_name)
+          # make sure that we don't reach SystemExit lines of file
+          expect { subject.delete }.to_not raise_error
+        end
+      end
+
+      context 'without remote rfml test' do
+        let(:test_data) { [OpenStruct.new(file_name: 'foobar.rfml')] }
+        let(:test_files) { OpenStruct.new(test_data: test_data) }
+
+        before do
+          allow(RainforestCli::TestFiles).to receive(:new).and_return(test_files)
+        end
+
+        it 'exits with the correct error' do
+          begin
+            expect_any_instance_of(
+              Logger
+            ).to receive(:fatal).with('Unable to delete remote rfml test')
+
+            subject.delete
+          rescue SystemExit => exception
+            expect(exception.status).to eq(2)
+          end
+        end
+      end
+    end
+  end
+end

data/spec/exporter_spec.rb

@@ -1,7 +1,15 @@
 # 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: [])
+    instance_double(
+      'RainforestCli::Options',
+      token: nil,
+      test_folder: nil,
+      command: nil,
+      debug: nil,
+      embed_tests: nil,
+      tests: []
+    )
   end
   subject { described_class.new(options) }
 
@@ -124,8 +132,8 @@ describe RainforestCli::Exporter do
       let(:options) do
         instance_double(
           'RainforestCli::Options',
-          token: nil, test_folder: nil,
-          debug: nil, embed_tests: true, tests: []
+          token: nil, test_folder: nil, command: nil,
+          debug: nil, embed_tests: true, tests: [],
         )
       end
 
@@ -141,8 +149,8 @@ describe RainforestCli::Exporter do
       let(:options) do
         instance_double(
           'RainforestCli::Options',
-          token: nil, test_folder: nil, debug: nil,
-          embed_tests: nil, tests: tests
+          token: nil, test_folder: nil, command: nil,
+          debug: nil, embed_tests: nil, tests: tests
         )
       end
 

data/spec/options_spec.rb

@@ -24,6 +24,18 @@ describe RainforestCli::OptionParser do
       its(:crowd) { should == 'some_name' }
     end
 
+    context 'new' do
+      let(:args) { ['new', 'foo.rfml']}
+      its(:command) { should == 'new' }
+      its(:file_name) { should == 'foo.rfml' }
+    end
+
+    context 'rm' do
+      let(:args) { ['rm', 'foo.rfml']}
+      its(:command) { should == 'rm' }
+      its(:file_name) { should == File.expand_path('foo.rfml') }
+    end
+
     context 'app_source_url' do
       let(:args) { ['--app-source-url', 'some_app'] }
       its(:app_source_url) { should == 'some_app' }
@@ -134,6 +146,11 @@ describe RainforestCli::OptionParser do
       it { raises_a_validation_exception }
     end
 
+    context 'with missing filename' do
+      let(:args) { %w(--token foo rm) }
+      it { raises_a_validation_exception }
+    end
+
     context 'with a custom url but no site id' do
       let(:args) { %w(--token foo --custom-url http://www.example.com) }
       it { raises_a_validation_exception }
@@ -155,13 +172,5 @@ describe RainforestCli::OptionParser do
         it { raises_a_validation_exception }
       end
     end
-
-    context 'with invalid browsers' do
-      let(:args) { %w{run --browsers lulbrowser --token foo} }
-
-      it 'raises an exception' do
-        expect { subject.validate! }.to raise_error(RainforestCli::OptionParser::BrowserException)
-      end
-    end
   end
 end

data/spec/test_files_spec.rb

@@ -1,9 +1,11 @@
 # frozen_string_literal: true
 describe RainforestCli::TestFiles do
+  let(:options) { instance_double('RainforestCli::Options', test_folder: nil, command: nil) }
+  subject { described_class.new(options) }
+
   describe '#test_data' do
     let(:test_directory) { File.dirname(__FILE__) + '/rainforest-example' }
-    let(:options) { instance_double('RainforestCli::Options', test_folder: test_directory) }
-    subject { described_class.new(options) }
+    let(:options) { instance_double('RainforestCli::Options', test_folder: test_directory, command: nil) }
 
     let(:rfml_test) { subject.test_data.first }
     let(:text_file) { File.read(test_directory + '/example_test.rfml') }
@@ -16,9 +18,6 @@ describe RainforestCli::TestFiles do
 
   describe '#test_dictionary' do
     Test = Struct.new(:rfml_id, :id)
-
-    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
@@ -31,4 +30,36 @@ describe RainforestCli::TestFiles do
       expect(subject.test_dictionary).to include({})
     end
   end
+
+  describe '#create_file' do
+    let(:file) { instance_double('File') }
+    let(:test_title) { 'My Test Title' }
+
+    it 'sets the file name as the given test title' do
+      allow(file).to receive(:write)
+
+      expect(File).to receive(:open).with(a_string_including("#{test_title}.rfml"), 'w').and_yield(file)
+      subject.create_file(test_title)
+    end
+
+    it 'sets the title of the test as the given test title' do
+      allow(File).to receive(:open).and_yield(file)
+
+      expect(file).to receive(:write).with(a_string_including("# title: #{test_title}"))
+      subject.create_file(test_title)
+    end
+
+    context 'when there is an existing file with the same title' do
+      before do
+        allow(file).to receive(:write)
+        expect(File).to receive(:exist?).twice.and_return(true).ordered
+        expect(File).to receive(:exist?).and_return(false).ordered
+      end
+
+      it 'sets the file name as given test title with a number for uniqueness' do
+        expect(File).to receive(:open).with(a_string_including("#{test_title} (2).rfml"), 'w').and_yield(file)
+        subject.create_file(test_title)
+      end
+    end
+  end
 end

data/spec/test_parser_spec.rb

@@ -26,6 +26,15 @@ describe RainforestCli::TestParser do
   describe RainforestCli::TestParser::Parser do
     subject { described_class.new(file_name) }
 
+    describe '#initialize' do
+      let(:file_name) { './spec/rainforest-example/example_test.rfml' }
+
+      it 'expands the file name path' do
+        test = subject.instance_variable_get(:@test)
+        expect(test.file_name).to eq(File.expand_path(file_name))
+      end
+    end
+
     describe '#process' do
       context 'redirection' do
         context 'step' do

data/spec/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) }
+  let(:options) { instance_double('RainforestCli::Options', token: 'foo', test_folder: test_directory, command: '') }
   subject { described_class.new(options) }
 
   before do

data/spec/validator_spec.rb

@@ -30,7 +30,7 @@ describe RainforestCli::Validator do
   shared_examples 'it detects all the correct errors' do
     let(:tested_method) { :validate }
     let(:raises_error) { false }
-    let(:options) { instance_double('RainforestCli::Options', test_folder: test_directory, token: 'api_token') }
+    let(:options) { instance_double('RainforestCli::Options', test_folder: test_directory, token: 'api_token', command: '') }
     subject { described_class.new(options) }
 
     before do
@@ -97,7 +97,7 @@ describe RainforestCli::Validator do
 
     context 'when multiple tests have the same rfml_ids' do
       let(:test_directory) { File.expand_path(File.join(__FILE__, '../validation-examples/duplicate_rfml_ids')) }
-      let(:options) { instance_double('RainforestCli::Options', test_folder: test_directory, token: 'api_token') }
+      let(:options) { instance_double('RainforestCli::Options', test_folder: test_directory, token: 'api_token', command: '') }
 
       subject { described_class.new(options) }
 
@@ -121,7 +121,7 @@ describe RainforestCli::Validator do
 
     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) }
+      let(:options) { instance_double('RainforestCli::Options', test_folder: test_directory, token: nil, command: '') }
       subject { described_class.new(options) }
 
       it 'validates locally and tells the user to include a token to valid with server tests as well' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rainforest-cli
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.6.0
 platform: ruby
 authors:
 - Russell Smith
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-23 00:00:00.000000000 Z
+date: 2016-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -164,6 +164,7 @@ files:
 - lib/rainforest/cli.rb
 - lib/rainforest/cli/constants.rb
 - lib/rainforest/cli/csv_importer.rb
+- lib/rainforest/cli/deleter.rb
 - lib/rainforest/cli/exporter.rb
 - lib/rainforest/cli/git_trigger.rb
 - lib/rainforest/cli/http_client.rb
@@ -179,6 +180,7 @@ files:
 - rainforest-cli.gemspec
 - spec/cli_spec.rb
 - spec/csv_importer_spec.rb
+- spec/deleter_spec.rb
 - spec/exporter_spec.rb
 - spec/fixtures/variables.txt
 - spec/git_trigger_spec.rb
@@ -239,6 +241,7 @@ summary: Command line utility for Rainforest QA
 test_files:
 - spec/cli_spec.rb
 - spec/csv_importer_spec.rb
+- spec/deleter_spec.rb
 - spec/exporter_spec.rb
 - spec/fixtures/variables.txt
 - spec/git_trigger_spec.rb