Ruby_AppThwack 0.0.8 → 0.0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0231d4e43df05a72e4183412e4e260f4621c3de2
-  data.tar.gz: 7434bcec5bd022443438ff85ac4db229bb6729d4
+  metadata.gz: 0cd4b08a721c892c9ded4ac4fb7d74cf0ac3db06
+  data.tar.gz: ebca17f72f26570c02dadf6039a9efefd6653b5b
 SHA512:
-  metadata.gz: 0dfcc92bacb3f368a8d7b22af7856c4e1c25ffad2db115f7c4f74225fa2175b34c6819961f50810f8d94453b397e845b58bbdb861402993d0c17b255e504e8e4
-  data.tar.gz: 25d1fe040f1be17dad913da85396749d4a9196ec52d19ef405bd511b75ace54f1db592a9d847132296e6824151fa0ee2105241e227bba20e851f2a46f78eb4f5
+  metadata.gz: 15e64edbca5b30dcbdc3c4cb0ad279b07a0e1e35ef664e945ae9d28544505eb62a0c7f54072f58c7b290fa3a60f8a89fab58bb2fae39917f683a41693409be03
+  data.tar.gz: 25789f0f34188d3b3554dacbde5896e33c70e74f82ce9da0defca7c06c1d5948e6b513b7ebdec293e35b6a53b98e3431ed91ffdb8213d834ab6c31b13e327af2

data/lib/ruby_appthwack/appthwack_api.rb

@@ -0,0 +1,102 @@
+
+require 'ostruct'
+require "json"
+require "typhoeus"
+
+module AppThwack::API
+
+  class << self
+      def get_project_id(name)
+        res = 
+          JSON.parse(
+            Typhoeus.get(
+              "https://appthwack.com/api/project/",
+              userpwd: "#{ENV['APPTHWACK_API_KEY']}:"
+            ).body
+          )
+        
+        return (res.select { |project| project['name'].eql? name }).first['id']
+      end
+
+      def get_device_pool(proj_id, name)
+        
+        res = 
+          JSON.parse(
+            Typhoeus.get(
+              "https://appthwack.com/api/devicepool/#{proj_id}",
+              userpwd: "#{ENV['APPTHWACK_API_KEY']}:"
+            ).body
+          )
+        
+        return (res.select { |pool| pool['name'].eql? name }).first['id']
+      end
+
+      
+      def download_file(src, dst)
+        # We use curl to download the file to avoid running out of RAM
+        return dst if system "curl -X GET '#{src}' -o '#{dst}' --silent"
+      end
+
+      def upload_file(src)
+        f = Dir.glob( src ).first
+
+        res = JSON.parse(
+          Typhoeus.post(
+            "https://appthwack.com/api/file",
+            userpwd: "#{ENV['APPTHWACK_API_KEY']}:",
+            params: {
+              name: File.basename(f)
+            },
+            body: {
+              file: File.open(f,"r")
+            }
+          ).body
+        )
+        
+        return { :file_id => res["file_id"], :succeeded? => res['message'].nil?, :message => res['message'] }
+      end
+
+      def start_test(name, proj_id, app_id, pool_id, params = {})
+
+        params.merge! project: proj_id, name: name, app: app_id, pool: pool_id
+
+        res = JSON.parse( 
+          Typhoeus.post(
+            "https://appthwack.com/api/run",
+            userpwd: "#{ENV['APPTHWACK_API_KEY']}:",
+            params: params
+          ).body
+        )
+        
+        return { :run_id => res['run_id'], :succeeded? => res['message'].nil?, :message => res['message'] }
+      end
+
+      def test_status?(proj_id, run_id)
+        res = JSON.parse(
+            Typhoeus.get(
+              "https://appthwack.com/api/run/#{proj_id}/#{run_id}/status",
+              userpwd: "#{ENV['APPTHWACK_API_KEY']}:",
+            ).body
+        )
+
+        return res['status']
+      end
+
+      def test_running?(proj_id, run_id)
+        return test_status?( proj_id, run_id ) != 'completed'
+      end
+
+      def download_results(proj_id, run_id, output)
+
+        resp = Typhoeus.get(
+          "https://appthwack.com/api/run/#{proj_id}/#{run_id}",
+          userpwd: "#{ENV['APPTHWACK_API_KEY']}:",
+          params: {
+            format: "archive"
+          }
+        )
+
+        return ( download_file resp.headers_hash['Location'], output ) if resp.code == 303
+      end
+  end
+end

data/lib/ruby_appthwack/commands/convert.rb

@@ -0,0 +1,13 @@
+command :convert do |c|
+  c.syntax = 'appthwack convert [options]'
+  c.option '--reports STRING', String, 'Location of reports folder.'
+  c.option '--platform STRING', String, 'Platform of tests.'
+  c.summary = 'Converts the AppThwack results into something readable for the Jenkins'
+  c.description = ''
+
+  c.action do |args, options|
+    dst = AppThwack::Reports.convert_reports options.reports, options.platform
+
+    say_ok "Converted reports to #{dst}"
+  end
+end

data/lib/ruby_appthwack/commands/report.rb

@@ -0,0 +1,33 @@
+command :reports do |c|
+	c.syntax = 'appthwack reports [arguments]'
+	c.summary = 'Downloads reports and tidies reports'
+	c.description = ''
+
+	c.option '--project PROJECT', 'The project name of the running tests'
+	c.option '--runid INT', 'The run ID of the test'
+	c.option '--platform PLATFORM', 'The mobile platform of the app under test'
+	c.option '--reports REPORTS', 'The location of the downloaded reports'
+
+	c.action do |args, options|
+		say_error 'Need project name and run ID' if options.runid.nil? or options.project.nil?
+		
+		options.proj_id = AppThwack::API.get_project_id(options.project)
+
+		say_ok "Project ID: #{options.proj_id}"
+
+		status = AppThwack::API.test_status? options.proj_id, options.runid
+
+		say_error 'Project is not finished' unless status.eql? 'completed'
+
+		say_ok 'Downloading reports...'
+
+		reports = AppThwack::API.download_results options.proj_id, options.runid, options.reports
+
+		say_ok "Downloaded raw reports to #{reports}"
+
+		reports = AppThwack::Reports.extract_reports reports
+
+		say_ok "Extracted reports to #{reports}"
+
+	end
+end

data/lib/ruby_appthwack/commands/run.rb

@@ -0,0 +1,88 @@
+command :run do |c|
+  c.syntax = 'appthwack run [options]'
+  c.summary = 'Packages tests and pushes them to AppThwack for Running'
+  c.description = ''
+
+  c.option '--platform PLATFORM', 'The platform of the application under test'
+  c.option '--project PROJECT', 'Name of AppThwack project'
+  c.option '--devices DEVICES', 'Name of device pool to use'
+  c.option '--testtype TYPE', 'Scheme used to build iOS app'
+  c.option '--app TEST', 'Path of the application (can be Glob syntax)'
+  c.option '--test TEST', 'Path of the test package'
+  c.option '--wait', 'Wait for the tests to complete'
+  c.option '--scheme SCHEME', 'XCode scheme for packaging the IPA'
+  c.option '--results STRING', String, 'Location of downloaded results.'
+  
+
+  c.action do |args, options|
+
+    options.proj_id   = AppThwack::API.get_project_id  options.project
+    options.pool_id   = AppThwack::API.get_device_pool options.proj_id,  options.devices
+
+    say_ok "Project ID: #{options.proj_id}"
+    say_ok "Pool ID:    #{options.pool_id}"
+
+    # Feature: list of tests to include via command line?
+    if options.testtype.eql? 'calabash'
+      options.test = AppThwack::Packaging.create_calabash_package options.proj_id, options.test
+    end
+
+    # if the platform is iOS, make an IPA before building
+    if options.platform.eql? 'ios'
+      options.app = AppThwack::Packaging.create_ipa(options.scheme)
+    end
+
+    # start by uploading the app
+    options.app_id = (AppThwack::API.upload_file options.app)[:file_id]
+    say_ok "App package ID:   #{options.app_id}"
+
+    exit 3 if options.app_id.nil?
+
+    # now upload the test package
+    options.test_id = (AppThwack::API.upload_file options.test)[:file_id] 
+
+    say_ok "Test packagae ID: #{options.test_id}"
+
+    exit 4 if options.test_id.nil?
+
+    params = {}
+
+    params['calabash'] = { calabash: options.test_id }
+
+    params['junit'] = { junit: options.test_id }
+
+    result = AppThwack::API.start_test(
+      File.basename(Dir.glob(options.app).first) + ' -- CLI', 
+      options.proj_id,
+      options.app_id, 
+      options.pool_id, 
+      params[options.testtype]
+    )
+
+    options.run_id = result[:run_id]
+
+    say_ok "Run ID: #{options.run_id} with message: #{result[:message]}"
+
+    exit 5 if options.run_id.nil?
+    
+    sleep 5
+
+    print "\n"
+
+    # wait for test to terminate
+    until not AppThwack::API.test_running? options.proj_id, options.run_id or not options.wait
+      print "."
+      sleep 30
+    end
+
+    print "\n"
+
+    # download the results if we waited..
+    if options.results and options.wait
+      `appthwack reports --project #{options.project} --runid #{options.run_id} --platform #{options.platform} --reports #{options.results}`
+    end
+
+    say_ok "Tests started successfully"
+
+  end
+end

data/lib/ruby_appthwack/commands/status.rb

@@ -0,0 +1,15 @@
+command :status do |c|
+	c.syntax = 'appthwack status [arguments]'
+	c.summary = 'Check on the status of a running test'
+	c.description = ''
+
+	c.option '--project PROJECT', 'The project name of the running tests'
+	c.option '--runid INT', 'The run ID of the test'
+
+
+	c.action do |args, options|
+		say_error 'Need project and run ID' if options.runid.nil? or options.project.nil?
+		
+		puts AppThwack::API.test_status? AppThwack::API.get_project_id(options.project), options.runid
+	end
+end

data/lib/ruby_appthwack/commands.rb

@@ -0,0 +1,6 @@
+$:.push File.expand_path('../', __FILE__)
+
+require 'commands/status'
+require 'commands/run'
+require 'commands/report'
+require 'commands/convert'

data/lib/ruby_appthwack/packaging.rb

@@ -0,0 +1,31 @@
+
+module AppThwack::Packaging
+
+	class << self
+		def create_ipa(scheme)
+		  #uses Shenzhen gem
+		  abort unless system "ipa build --scheme #{scheme} --configuration Release --no-archive"
+
+		  return Dir.glob('*.ipa').first
+		end
+
+		def create_calabash_package proj_id, src, opts = {}
+		    o = { :include_tests=> ["*.feature"], :exclude_tests=> nil}.merge opts
+
+		    # create the archive if it doesn't already exist
+		    unless File.extname(src) == '.zip'
+		        # delete any old archives we have laying about
+		        File.delete(src + '.zip') if File.exists?(src + '.zip')
+
+		        included = (o[:include_tests].map { |t| "'#{src}/#{t}'"}).join(' ')
+		        excluded = if o[:exclude_tests]; "-x #{ (o[:exclude_tests].map { |t| "'#{calabash}/#{t}'"}).join(' ') }" else "" end
+ 
+		        `zip #{src}.zip #{src} . -r #{excluded} -i '#{src}/support/*' '#{src}/step_definitions/*' #{included}`
+		    end
+
+		    src << '.zip'
+
+		    return src
+		end
+	end
+end

data/lib/ruby_appthwack/reports.rb

@@ -0,0 +1,73 @@
+require 'json'
+require 'pp'
+
+module AppThwack::Reports
+	class << self
+
+		def extract_reports(reports)
+			# make new folder name by chopping off .zip file
+			out = reports.sub('.zip', '')
+			# unzip then return the new folder name
+			out if system "rm -rf #{out} && unzip -qq #{reports} -d #{out}"
+		end
+
+		# Converts Android reports into results readable by Cucumber plugin.
+		# You should pass in the folder locatino of the reports
+		def convert_reports(reports, platform='android')
+			# default to android folder
+			intermediate_folders = 'calabash_tests_from_features.zip'
+
+			dst = 'cucumber-html-reports'
+
+			# unless platform is explicitly ios
+			if platform.eql? 'ios'
+				 intermediate_folders = 'calabash'
+			end
+
+			folders = Dir["#{reports}/*"]
+
+			# extract for each of the devices
+			folders.each do |f|
+
+				# capitalize every word
+				device = f.gsub('_', ' ').split.map(&:capitalize).join(' ')
+
+				report = File.join(f, intermediate_folders, 'raw_calabash_json_output.instrtxt')
+				
+				if File.exists? report
+					features = []
+					
+
+					# now we just add the device prefix to each feature name to make it unique
+					File.open(report, 'r') do |io|
+
+						features = JSON.load(io)
+
+						if not features.nil?
+							
+							features.each_index do |i|
+								# append the device name to the feature name
+								features[i]['name'] = "#{features[i]['name']} on #{device}"
+							end
+						end
+
+						Dir.mkdir dst if not Dir.exists? dst
+
+						# original folder name
+						folder_name = f.sub(reports + "/", '')
+
+						# now write out the new file
+						File.open(File.join(dst, "#{Time.now.to_i}_#{folder_name}.json"), 'w') do |io|
+							JSON.dump(features, io) unless features.nil?
+
+						end
+					end
+				end
+			end
+
+			dst
+		end
+
+		
+	end
+end

data/lib/ruby_appthwack.rb

@@ -1,5 +1,5 @@
 module AppThwack
-	VERSION = '0.0.8'
+	VERSION = '0.0.8.1'
 end
 
 require'ruby_appthwack/reports.rb'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: Ruby_AppThwack
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.8.1
 platform: ruby
 authors:
 - Sam Stewart
@@ -144,6 +144,14 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/ruby_appthwack.rb
+- lib/ruby_appthwack/appthwack_api.rb
+- lib/ruby_appthwack/commands.rb
+- lib/ruby_appthwack/packaging.rb
+- lib/ruby_appthwack/reports.rb
+- lib/ruby_appthwack/commands/convert.rb
+- lib/ruby_appthwack/commands/report.rb
+- lib/ruby_appthwack/commands/run.rb
+- lib/ruby_appthwack/commands/status.rb
 - bin/appthwack
 homepage: https://github.com/samstewart/ruby_appthwack
 licenses: []