rainforest-cli 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 70b8d8fad3a7886f4cdff271fc383dca7614061a
-  data.tar.gz: b9bc2a5e63a3b95ad661a6d74212f9b01a8cefee
+  metadata.gz: 854465637763f313d813365ea7996c8aa2d43808
+  data.tar.gz: 44115420d528b8ee03e501eba5fca683439aecca
 SHA512:
-  metadata.gz: c0888185bfefe12bf782dbf73c380b5c75dc3d36bdc8971031b467ff716b152989ebfcafe24ded4c67fe2a190f20a5e87a2ef0fcc8c7ddf880af2cf98ec4be9a
-  data.tar.gz: f0080514d2ae49f2bec4662e746343ab8336e721f97e32f3f00250d340b24444cd4290aaa88bb90b59d7d3bab65676b026c26051ba3247294d62b409e8d574f1
+  metadata.gz: 6c8ed4a11a1bca3e2b58672f1ebaae2c3e12265d458107bd19082a193f44cc47bb22113c4d9714190e19bff7fa383ebab4d8cc4d5b260ffc28a3462c72dff957
+  data.tar.gz: 3a335dbc44d8a00c7910d5b1eabb66d6f25e0d7f4d4e9f982b2b246d8450ec78706c189afbbf817559d091eb613a81dc19f80a319b857289ae02848add661f32

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Rainforest CLI Changelog
 
+## 1.5.0
+- 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
 - Support for new `--version` command. (4362c85fe599a02eaa1b772d184be31e692e934e, @epaulet)
 - Validate duplicate RFML IDs before uploading. (67f71d053c755eaf92c1bd205931e89e903b88c9, @curtis-rainforestqa)

data/README.md

@@ -72,6 +72,11 @@ See a list of all of your smart folders and their IDs
 rainforest folders
 ```
 
+See a list of all of your browsers and their IDs
+```bash
+rainforest browsers
+```
+
 ## Options
 
 ### General
@@ -87,6 +92,7 @@ Rainforest Tests written using RFML have the following format
 # start_uri: [START_URI]
 # tags: [TAGS]
 # site_id: [SITE ID]
+# browsers: [BROWSER IDS]
 # [OTHER COMMENTS]
 
 [ACTION 1]
@@ -116,6 +122,8 @@ Optional Fields:
 - `SITE ID` - Site ID for the site this test is for. You can find your available
 site IDs with the `sites` command. Sites can be configured at
 https://app.rainforestqa.com/settings/sites.
+- `BROWSER IDS` - Comma separated list of browsers for this test. You can reference
+your available browsers with the `browsers` command.
 - `TAGS` - Comma separated list of your desired tags for this test.
 - `OTHER COMMENTS` - Any comments you'd like to save to this test. All lines beginning with
 `#` will be ignored by Rainforest unless they begin with a supported data field,

data/lib/rainforest/cli.rb

@@ -35,7 +35,8 @@ module RainforestCli
     when 'validate' then Validator.new(options).validate
     when 'upload' then Uploader.new(options).upload
     when 'export' then Exporter.new(options).export
-    when 'sites', 'folders' then Resources.new(options).public_send(options.command)
+    when 'sites', 'folders', 'browsers'
+      Resources.new(options).public_send(options.command)
     else
       logger.fatal 'Unknown command'
       exit 2

data/lib/rainforest/cli/exporter.rb

@@ -64,8 +64,8 @@ class RainforestCli::Exporter
     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]
+      file.puts element[:element][:action].gsub("\n", ' ')
+      file.puts element[:element][:response].gsub("\n", ' ')
     else
       raise "Unknown element type: #{element[:type]}"
     end

data/lib/rainforest/cli/http_client.rb

@@ -23,14 +23,16 @@ module RainforestCli
       JSON.parse(response.body)
     end
 
-    def post(url, body = {})
-      response = HTTParty.post make_url(url), {
-        body: body,
-        headers: headers,
-        verify: false
-      }
+    def post(url, body = {}, options = {})
+      wrap_exceptions(options[:retries_on_failures]) do
+        response = HTTParty.post make_url(url), {
+          body: body,
+          headers: headers,
+          verify: false
+        }
 
-      JSON.parse(response.body)
+        return JSON.parse(response.body)
+      end
     end
 
     def get(url, body = {}, options = {})

data/lib/rainforest/cli/resources.rb

@@ -1,43 +1,49 @@
 # frozen_string_literal: true
 class RainforestCli::Resources
+  Resource = Struct.new(:identifier, :name)
+
   def initialize(options)
     @client = RainforestCli::HttpClient.new(token: options.token)
   end
 
   def sites
-    sites = @client.get('/sites')
+    sites = @client.get('/sites').map { |s| Resource.new(s['id'], s['name']) }
 
     if sites.empty?
       logger.info('No sites found on your account.')
       logger.info('Please visit https://app.rainforestqa.com/settings/sites to create and edit your sites.')
     else
-      print_table('Site', sites) do |site|
-        { id: site['id'], name: site['name'] }
-      end
+      print_table('Site', sites)
     end
   end
 
   def folders
-    folders = @client.get('/folders')
+    folders = @client.get('/folders').map { |f| Resource.new(f['id'], f['title']) }
 
     if folders.empty?
       logger.info('No folders found on your account.')
       logger.info('Please visit https://app.rainforestqa.com/folders to create and edit your sites.')
     else
-      print_table('Folder', folders) do |folder|
-        { id: folder['id'], name: folder['title'] }
-      end
+      print_table('Folder', folders)
     end
   end
 
+  def browsers
+    account = @client.get('/clients')
+    browsers = account['available_browsers'].map { |b| Resource.new(b['name'], b['description']) }
+    print_table('Browser', browsers)
+  end
+
   def print_table(resource_name, resources)
     id_col = "#{resource_name} ID"
-    table_heading = "#{id_col} | #{resource_name} Name"
+    longest_id = resources.map { |r| r.identifier.to_s }.max_by(&:length)
+    col_length = [id_col.length, longest_id.length].max
+
+    table_heading = "#{id_col.rjust(col_length)} | #{resource_name} Name"
     puts table_heading
     puts '-' * table_heading.length
     resources.each do |resource|
-      resource_data = yield(resource)
-      puts "#{resource_data[:id].to_s.rjust(id_col.length)} | #{resource_data[:name]}"
+      puts "#{resource.identifier.to_s.rjust(col_length)} | #{resource.name}"
     end
   end
 

data/lib/rainforest/cli/runner.rb

@@ -19,7 +19,7 @@ module RainforestCli
       logger.debug "POST options: #{post_opts.inspect}"
       logger.info 'Issuing run'
 
-      response = client.post('/runs', post_opts)
+      response = client.post('/runs', post_opts, retries_on_failures: true)
 
       if response['error']
         logger.fatal "Error starting your run: #{response['error']}"
@@ -99,7 +99,9 @@ module RainforestCli
         end
       end
 
-      post_opts[:app_source_url] = options.app_source_url if options.app_source_url
+      app_source_url = options.app_source_url ? upload_app(options.app_source_url) : options.app_source_url
+
+      post_opts[:app_source_url] = app_source_url if app_source_url
       post_opts[:crowd] = options.crowd if options.crowd
       post_opts[:conflict] = options.conflict if options.conflict
       post_opts[:browsers] = options.browsers if options.browsers
@@ -153,5 +155,55 @@ module RainforestCli
 
       return environment['id']
     end
+
+    def upload_app(app_source_url)
+      return app_source_url if url_valid?(app_source_url)
+
+      unless File.exist?(app_source_url)
+        logger.fatal "App source file: #{app_source_url} not found"
+        exit 1
+      end
+
+      unless File.extname(app_source_url) == '.ipa'
+        logger.fatal "Invalid app source file: #{app_source_url}"
+        exit 1
+      end
+
+      url = client.get('/uploads', {}, retries_on_failures: true)
+      unless url
+        logger.fatal "Failed to upload file #{app_source_url}. Please, check your API token."
+        exit 1
+      end
+      data = File.read(app_source_url)
+      logger.info 'Uploading app source file, this operation may take few minutes...'
+      response_code = upload_file(url, data)
+
+      if response_code != '200'
+        logger.fatal "Failed to upload file #{app_source_url}"
+        exit 1
+      else
+        logger.info 'Upload completed.'
+        return url['path']
+      end
+    end
+
+    def upload_file(url, body)
+      begin
+        # using Net::HTTP because HTTParty do not support large files
+        http = Net::HTTP.new(url['host'], url['port'])
+        http.use_ssl = true
+        http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+
+        request = Net::HTTP::Put.new(url['uri'])
+        request['Content-Type'] = 'application/zip'
+        request.body = body
+
+        response = http.request(request)
+        return response.code
+      rescue Http::Exceptions::HttpException => e
+        logger.fatal "Error uploading the app source file: #{e.message}"
+        exit 1
+      end
+    end
   end
 end

data/lib/rainforest/cli/test_parser.rb

@@ -87,7 +87,7 @@ module RainforestCli::TestParser
       @test.browsers = []
     end
 
-    TEST_DATA_FIELDS = [:start_uri, :title, :tags, :site_id].freeze
+    TEST_DATA_FIELDS = [:start_uri, :title, :site_id, :browsers].freeze
     STEP_DATA_FIELDS = [:redirect].freeze
     CSV_FIELDS = [:tags, :browsers].freeze
 

data/lib/rainforest/cli/version.rb

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

data/spec/cli_spec.rb

@@ -102,7 +102,7 @@ describe RainforestCli do
 
         it 'starts the run with the specified tags' do
           expect_any_instance_of(http_client).to receive(:post)
-            .with('/runs', tags: ['run-me']).and_return({})
+            .with('/runs', { tags: ['run-me'] }, { retries_on_failures: true }).and_return({})
 
           start_with_params(params, 0)
         end
@@ -116,7 +116,7 @@ describe RainforestCli do
           .with('/environments', name: 'temporary-env-for-custom-url-via-CLI', url: 'http://ad-hoc.example.com')
           .and_return({ 'id' => 333 })
 
-        expect_any_instance_of(http_client).to receive(:post).with('/runs', anything)
+        expect_any_instance_of(http_client).to receive(:post).with('/runs', anything, { retries_on_failures: true })
           .and_return({ 'id' => 1 })
 
         # This is a hack because when expecting a function to be called with
@@ -140,7 +140,8 @@ describe RainforestCli do
 
         expect_any_instance_of(http_client).to receive(:post).with(
           '/runs',
-          { tests: [], site_id: 3, environment_id: 333 }
+          { tests: [], site_id: 3, environment_id: 333 },
+          { retries_on_failures: true }
         ).and_return({})
         described_class.start(params)
       end
@@ -155,7 +156,8 @@ describe RainforestCli do
 
         expect_any_instance_of(http_client).to receive(:post).with(
           '/runs',
-          { tests: [], environment_id: 123 }
+          { tests: [], environment_id: 123 },
+          { retries_on_failures: true }
         ).and_return({})
         described_class.start(params)
       end
@@ -167,7 +169,8 @@ describe RainforestCli do
       it 'starts the run with smart folder' do
         expect_any_instance_of(http_client).to receive(:post).with(
           '/runs',
-          { smart_folder_id: 123 }
+          { smart_folder_id: 123 },
+          { retries_on_failures: true }
         ).and_return({})
         described_class.start(params)
       end
@@ -179,7 +182,8 @@ describe RainforestCli do
       it 'starts the run without error' do
         expect_any_instance_of(http_client).to receive(:post).with(
           '/runs',
-          { tests: [] }
+          { tests: [] },
+          { retries_on_failures: true }
         ).and_return({})
         allow(ENV).to receive(:[]).with('RAINFOREST_API_TOKEN').and_return('x')
         described_class.start(params)

data/spec/exporter_spec.rb

@@ -9,6 +9,11 @@ describe RainforestCli::Exporter do
     # Collect everything printed to file in an array-like file double object
     class FileDouble < Array
       alias_method :puts, :push
+
+      # join into a string like a file
+      def include?(str)
+        join("\n").include?(str)
+      end
     end
 
     let(:file) { FileDouble.new }
@@ -28,6 +33,21 @@ describe RainforestCli::Exporter do
         ]
       }
     end
+    let(:test_elements) do
+      [
+        {
+          type: 'step',
+          element: {
+            action: 'Step Action',
+            response: 'Step Response'
+          }
+        },
+        {
+          type: 'test',
+          element: embedded_test
+        }
+      ]
+    end
     let(:single_test) do
       Rainforest::Test.new(
         {
@@ -36,32 +56,11 @@ describe RainforestCli::Exporter do
           start_uri: '/uri',
           tags: ['foo', 'bar'],
           browsers: [
-            {
-              name: 'chrome',
-              state: 'enabled'
-            },
-            {
-              name: 'safari',
-              state: 'enabled'
-            },
-            {
-              name: 'firefox',
-              state: 'disabled'
-            }
+            { 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
-            }
-          ]
+          elements: test_elements
         }
       )
     end
@@ -98,6 +97,29 @@ describe RainforestCli::Exporter do
       expect(comments).to_not include('firefox')
     end
 
+    context 'action and/or question contain newlines' do
+      let(:action) { "Step Action\nwith newlines\n" }
+      let(:expected_action) { 'Step Action with newlines' }
+      let(:response) { "Step Response\nwith\nnewlines\n" }
+      let(:expected_response) { 'Step Response with newlines' }
+      let(:test_elements) do
+        [
+          {
+            type: 'step',
+            element: {
+              action: action,
+              response: response
+            }
+          }
+        ]
+      end
+
+      it 'removes the newlines' do
+        expect(file).to include(expected_action)
+        expect(file).to include(expected_response)
+      end
+    end
+
     context 'with embed-tests flag' do
       let(:options) do
         instance_double(

data/spec/resources_spec.rb

@@ -3,6 +3,22 @@ describe RainforestCli::Resources do
   let(:options) { instance_double('RainforestCli::Options', token: 'fake_token') }
   subject { described_class.new(options) }
 
+  shared_examples 'a properly formatted resource' do |tested_method|
+    before do
+      allow_any_instance_of(RainforestCli::HttpClient).to receive(:get).and_return(api_response)
+    end
+
+    it 'calls the print method with the correct information' do
+      expect(subject).to receive(:print_table) do |_name, resources|
+        resource = resources.first
+        expect(resource.identifier).to eq(expected_id)
+        expect(resource.name).to eq(expected_name)
+      end
+
+      subject.send(tested_method)
+    end
+  end
+
   describe '#sites' do
     context 'no sites configured' do
       before do
@@ -22,39 +38,17 @@ describe RainforestCli::Resources do
     end
 
     context 'with sites in account' do
-      let(:sites) do
+      let(:api_response) do
         [
-          {
-            'id' => 123,
-            'name' => 'The Foo Site'
-          },
-          {
-            'id' => 456,
-            'name'=> 'The Bar Site'
-          },
-          {
-            'id' => 789,
-            'name' => 'The Baz Site'
-          }
+          { 'id' => 123, 'name' => 'The Foo Site' },
+          { 'id' => 456, 'name'=> 'The Bar Site' },
+          { 'id' => 789, 'name' => 'The Baz Site' }
         ]
       end
+      let(:expected_id) { api_response.first['id'] }
+      let(:expected_name) { api_response.first['name'] }
 
-      before do
-        allow_any_instance_of(RainforestCli::HttpClient).to receive(:get).and_return(sites)
-      end
-
-      it 'calls the print method' do
-        expect(subject).to receive(:print_table).with('Site', sites).and_yield(sites.first)
-        subject.sites
-      end
-
-      it 'correctly formats the site information in the given block' do
-        expect(subject).to receive(:print_table) do |_resource_name, _resource, &blk|
-          site = sites.first
-          expect(blk.call(site)).to include(id: site['id'], name: site['name'])
-        end
-        subject.sites
-      end
+      it_should_behave_like 'a properly formatted resource', :sites
     end
   end
 
@@ -77,46 +71,39 @@ describe RainforestCli::Resources do
     end
 
     context 'with folders in account' do
-      let(:folders) do
+      let(:api_response) do
         [
-          {
-            'id' => 123,
-            'title' => 'The Foo Folder'
-          },
-          {
-            'id' => 456,
-            'title'=> 'The Bar Folder'
-          },
-          {
-            'id' => 789,
-            'title' => 'The Baz Folder'
-          }
+          { 'id' => 123, 'title' => 'The Foo Folder' },
+          { 'id' => 456, 'title'=> 'The Bar Folder' },
+          { 'id' => 789, 'title' => 'The Baz Folder' }
         ]
       end
+      let(:expected_id) { api_response.first['id'] }
+      let(:expected_name) { api_response.first['title'] }
 
-      before do
-        allow_any_instance_of(RainforestCli::HttpClient).to receive(:get).and_return(folders)
-      end
-
-      it 'calls the print method' do
-        expect(subject).to receive(:print_table).with('Folder', folders).and_yield(folders.first)
-        subject.folders
-      end
+      it_should_behave_like 'a properly formatted resource', :folders
+    end
+  end
 
-      it 'correctly formats the site information in the given block' do
-        expect(subject).to receive(:print_table) do |_resource_name, _resource, &blk|
-          folder = folders.first
-          expect(blk.call(folder)).to include(id: folder['id'], name: folder['title'])
-        end
-        subject.folders
-      end
+  describe '#browsers' do
+    let(:api_resources) do
+      [
+        { 'name' => 'chrome', 'description' => 'Chrome' },
+        { 'name' => 'safari', 'description' => 'Safari' },
+        { 'name' => 'firefox', 'description' => 'Firefox' }
+      ]
     end
+    let(:api_response) { { 'available_browsers' => api_resources } }
+    let(:expected_id) { api_resources.first['name'] }
+    let(:expected_name) { api_resources.first['description'] }
+
+    it_should_behave_like 'a properly formatted resource', :browsers
   end
 
   describe '#print_table' do
     let(:resource_id) { 123456 }
     let(:resource_name) { 'resource name' }
-    let(:resources) { [ { id: resource_id, name: resource_name } ] }
+    let(:resources) { [ RainforestCli::Resources::Resource.new(resource_id, resource_name) ] }
 
     it 'prints out the resources' do
       expect(subject).to receive(:puts) do |message|
@@ -132,9 +119,7 @@ describe RainforestCli::Resources do
         expect(message).to include(resource_name)
       end
 
-      subject.print_table('Resource', resources) do
-        { id: resource_id, name: resource_name }
-      end
+      subject.print_table('Resource', resources)
     end
   end
 end

data/spec/runner_spec.rb

@@ -57,4 +57,72 @@ describe RainforestCli::Runner do
     end
   end
 
+  describe '#upload_app' do
+
+    context 'with valid URL' do
+      it 'returns the given app_source_url' do
+        expect(subject.upload_app('http://my.app.url')).to eq 'http://my.app.url'
+      end
+    end
+
+    context 'with invalid URL' do
+
+      it 'errors out and exits if the file does not exists' do
+        expect_any_instance_of(Logger).to receive(:fatal).with('App source file: fobar not found')
+        expect do
+          subject.upload_app('fobar')
+        end.to raise_error(SystemExit) { |error|
+          expect(error.status).to eq 1
+        }
+      end
+
+      it 'errors out and exits if not an .ipa file' do
+        File.should_receive(:exist?).with('fobar.txt') { true }
+        expect_any_instance_of(Logger).to receive(:fatal).with('Invalid app source file: fobar.txt')
+        expect do
+          subject.upload_app('fobar.txt')
+        end.to raise_error(SystemExit) { |error|
+          expect(error.status).to eq 1
+        }
+      end
+
+      it 'errors out and exits if valid file but invalid token' do
+        File.should_receive(:exist?).with('fobar.ipa') { true }
+        subject.client.should_receive(:get).with('/uploads', {}, retries_on_failures: true) { nil }
+        expect_any_instance_of(Logger).to receive(:fatal).with(
+          'Failed to upload file fobar.ipa. Please, check your API token.')
+        expect do
+          subject.upload_app('fobar.ipa')
+        end.to raise_error(SystemExit) { |error|
+          expect(error.status).to eq 1
+        }
+      end
+
+      it 'errors out and exits if was not possible to upload the file' do
+        File.should_receive(:exist?).with('fobar.ipa') { true }
+        File.should_receive(:read).with('fobar.ipa') { 'File data' }
+        url = {'host' => 'host', 'port' => 'port', 'uri' => 'uri', 'path' => 'path'}
+        subject.client.should_receive(:get).with('/uploads', {}, retries_on_failures: true) { url }
+        subject.should_receive(:upload_file).with(url, 'File data') { '500' }
+        expect_any_instance_of(Logger).to receive(:fatal).with('Failed to upload file fobar.ipa')
+        expect do
+          subject.upload_app('fobar.ipa')
+        end.to raise_error(SystemExit) { |error|
+          expect(error.status).to eq 1
+        }
+      end
+
+      it 'returns the new app_source_url in case of success' do
+        File.should_receive(:exist?).with('fobar.ipa') { true }
+        File.should_receive(:read).with('fobar.ipa') { 'File data' }
+        url = {'host' => 'host', 'port' => 'port', 'uri' => 'uri', 'path' => 'path'}
+        subject.client.should_receive(:get).with('/uploads', {}, retries_on_failures: true) { url }
+        subject.should_receive(:upload_file).with(url, 'File data') { '200' }
+
+        expect(subject.upload_app('fobar.ipa')).to eq 'path'
+      end
+
+    end
+  end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rainforest-cli
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Russell Smith
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-22 00:00:00.000000000 Z
+date: 2016-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty