fastlane-plugin-perfecto 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 82f5d7b6f7e5ea27af278d49c664729a69cf215783ec58cf384a741cd402ebe3
+  data.tar.gz: dae80b7419c950252f8eb2402e92b1a24001ba522711e02c0a34a1304d603687
+SHA512:
+  metadata.gz: c1d5dcf6c5f002d5e9a85e7808a5cf9ab000d2b7a96e1ee0ac445ef8635c5cc238332da943ccd8f900ce67fe0a37a303573136a9152a77b2e57ad8ca8aa3343c
+  data.tar.gz: efba9f2a9c5ea6763d006ca40317f851d172bf15bf76cd40bfd91c167e769562bfd7b38cb51c332a457b1040cca0d8af833f751f379c01e6fa79c15ae283aa0a

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 genesisthomas <genesist@perfectomobile.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,100 @@
+# perfecto plugin
+
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-perfecto)
+[![CircleCI](https://circleci.com/gh/PerfectoMobileSA/fastlane-plugin-perfecto/tree/master.svg?style=svg)](https://circleci.com/gh/PerfectoMobileSA/fastlane-plugin-perfecto/tree/master)
+
+## Getting Started
+
+This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-perfecto`, add it to your project by running:
+
+```bash
+fastlane add_plugin perfecto
+```
+
+## About perfecto
+
+This plugin allows you to automatically upload ipa/apk files to Perfecto for manual/automation testing
+
+
+## Example
+
+Check out the [example `Fastfile`](fastlane/Fastfile) to see how to use this plugin. Try it by cloning the repo, running `fastlane install_plugins` and `bundle exec fastlane test`.
+You can easily upload your ipa/apk file using perfecto fastlane Plugin and execute your test on perfecto cloud.
+
+Add the below action in your fastfile to utilize this plugin.  
+
+```
+lane :test do
+  perfecto(
+    perfecto_cloudurl: ENV["PERFECTO_CLOUDURL"],
+    perfecto_token: ENV["PERFECTO_TOKEN"],
+    perfecto_media_location: ENV["PERFECTO_MEDIA_LOCATION"],
+    file_path: ENV['GRADLE_APK_OUTPUT_PATH']
+  )
+end
+```
+### Note: <br>
+Pass the below variable values as environment variables:<br>
+PERFECTO_CLOUDURL  [your perfecto cloud url. E.g.: demo.perfectomobile.com]<br>
+PERFECTO_TOKEN [your perfecto [`security token`](https://developers.perfectomobile.com/display/PD/Generate+security+tokens)]<br>
+PERFECTO_MEDIA_LOCATION	[mention the Perfecto media repository location to upload the file mentioned in file_path. E.g. PUBLIC:Samples/sample.ipa]<br>
+file_path [location of your preferred ipa/apk file which needs to be uploaded to perfecto media repository.]<br>
+slack_webhook [Slack incoming webhook for slack integration. more info: [`here`](https://docs.fastlane.tools/actions/slack/)]<br>
+
+Here's a [`sample project`](https://github.com/PerfectoMobileSA/FastlaneEspressoCircleCISlackSample) which demonstrates the usage of this plugin. 
+
+The following actions are possible with the [`sample project`](https://github.com/PerfectoMobileSA/FastlaneEspressoCircleCISlackSample):
+
+## Available Actions:
+## Android
+### android test
+```
+fastlane android test
+```
+build, upload and run on perfecto
+### android apk
+```
+fastlane android apk
+```
+Build debug APK and upload to perfecto
+### android test_apk
+```
+fastlane android test_apk
+```
+Build debug test APK and upload to perfecto
+### android run_perfecto
+```
+fastlane android run_perfecto
+```
+Run on perfecto
+### android slack_report
+```
+fastlane android slack_report
+```
+Report perfecto url to slack
+
+
+## Run tests for this plugin
+
+To run both the tests, and code style validation, run
+
+```
+rake
+```
+
+To automatically fix many of the styling issues, use
+```
+rubocop -a
+```
+
+## Issues and Feedback
+
+For any other issues and feedback about this plugin, please submit it to this repository.
+
+## Troubleshooting
+
+If you have trouble using plugins, check out the [Plugins Troubleshooting](https://docs.fastlane.tools/plugins/plugins-troubleshooting/) guide.
+
+## About _fastlane_
+
+_fastlane_ is the easiest way to automate beta deployments and releases for your iOS and Android apps. To learn more, check out [fastlane.tools](https://fastlane.tools).

data/lib/fastlane/plugin/perfecto.rb

@@ -0,0 +1,16 @@
+require 'fastlane/plugin/perfecto/version'
+
+module Fastlane
+  module Perfecto
+    # Return all .rb files inside the "actions" and "helper" directory
+    def self.all_classes
+      Dir[File.expand_path('**/{actions,helper}/*.rb', File.dirname(__FILE__))]
+    end
+  end
+end
+
+# By default we want to import all available actions and helpers
+# A plugin can contain any number of actions and plugins
+Fastlane::Perfecto.all_classes.each do |current|
+  require current
+end

data/lib/fastlane/plugin/perfecto/actions/perfecto_action.rb

@@ -0,0 +1,142 @@
+require 'fastlane/action'
+require_relative '../helper/perfecto_helper'
+require 'json'
+
+module Fastlane
+  module Actions
+    module SharedValues
+      PERFECTO_MEDIA_FULLPATH ||= :PERFECTO_MEDIA_FULLPATH
+    end
+    class PerfectoAction < Action
+      SUPPORTED_FILE_EXTENSIONS = ["ipa", "apk"]
+
+      def self.run(params)
+        # Mandatory parameters
+        perfecto_cloudurl = params[:perfecto_cloudurl]
+        perfecto_token = params[:perfecto_token]
+        filepath = params[:file_path].to_s
+        perfecto_media_fullpath = params[:perfecto_media_location]
+
+        # validates the filepath and perfecto media location file
+        UI.message("validating filepath")
+        validate_filepath(filepath)
+        UI.message("validating  media location")
+        validate_repopath(perfecto_media_fullpath)
+
+        # uploads the ipa/apk to perfecto media repository
+        UI.message("Attempting to upload: " + filepath + " to Perfecto!")
+        Helper::PerfectoHelper.upload_file(perfecto_cloudurl, perfecto_token, filepath, perfecto_media_fullpath)
+        UI.success("The File in: " + filepath + " is successfully uploaded to Perfecto media location : " + perfecto_media_fullpath)
+
+        # Setting the environment variable: PERFECTO_MEDIA_FULLPATH with the perfecto media repository location.
+        ENV['PERFECTO_MEDIA_FULLPATH'] = nil
+        ENV['PERFECTO_MEDIA_FULLPATH'] = perfecto_media_fullpath
+        UI.success("Setting Environment variable PERFECTO_MEDIA_FULLPATH = " + ENV['PERFECTO_MEDIA_FULLPATH'])
+
+        # Setting the media fullpath in shared values post successful upload in order to be used by other fastlane actions.
+        Actions.lane_context[SharedValues::PERFECTO_MEDIA_FULLPATH] = perfecto_media_fullpath
+      end
+
+      def self.description
+        "This plugin allows you to automatically upload ipa/apk files to Perfecto for manual/automation testing"
+      end
+
+      def self.authors
+        ["genesisthomas"]
+      end
+
+      def self.return_value
+        # If your method provides a return value, you can describe here what it does
+      end
+
+      def self.details
+        # Optional:
+        "A fastlane plugin which aids in automated deployment of ipa/apk files to Perfecto iOS/Android devices"
+      end
+
+      # Validate filepath.
+      def self.validate_filepath(filepath)
+        UI.user_error!("No file found at filepath parameter location.") unless File.exist?(filepath)
+
+        # Validate file extension.
+        filepath_parts = filepath.split(".")
+        unless filepath_parts.length > 1 && SUPPORTED_FILE_EXTENSIONS.include?(filepath_parts.last)
+          UI.user_error!("filepath is invalid, only files with extensions with .ipa or .apk are allowed to be uploaded.")
+        end
+      end
+
+      # Validate media repo path.
+      def self.validate_repopath(perfecto_media_fullpath)
+        # Validate file extension.
+        filepath_parts = perfecto_media_fullpath.split(".")
+        unless filepath_parts.length > 1 && SUPPORTED_FILE_EXTENSIONS.include?(filepath_parts.last)
+          UI.user_error!("perfecto_media_location is invalid, only files with extensions with .ipa or .apk are allowed to be uploaded.")
+        end
+      end
+
+      def self.output
+        [
+          ['perfecto_media_fullpath', 'Perfecto media repo location']
+        ]
+      end
+
+      def self.default_file_path
+        platform = Actions.lane_context[Actions::SharedValues::PLATFORM_NAME]
+        if platform == :ios
+          # Shared value for ipa path if it was generated by gym https://docs.fastlane.tools/actions/gym/.
+          return Actions.lane_context[Actions::SharedValues::IPA_OUTPUT_PATH]
+        else
+          # Shared value for apk if it was generated by gradle.
+          return Actions.lane_context[Actions::SharedValues::GRADLE_APK_OUTPUT_PATH]
+        end
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :perfecto_cloudurl,
+                                       description: "Perfecto's cloud url",
+                                       optional: false,
+                                       is_string: true,
+                                       verify_block: proc do |value|
+                                         UI.user_error!("No perfecto_cloudurl given.") if value.to_s.empty?
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :perfecto_token,
+                                       description: "Perfecto's security token",
+                                       optional: false,
+                                       is_string: true,
+                                       verify_block: proc do |value|
+                                         UI.user_error!("No perfecto_token given.") if value.to_s.empty?
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :perfecto_media_location,
+                                        description: "Path to Perfecto media location",
+                                        optional: false,
+                                        is_string: true,
+                                        verify_block: proc do |value|
+                                          UI.user_error!("No perfecto_media_location given.") if value.to_s.empty?
+                                        end),
+          FastlaneCore::ConfigItem.new(key: :file_path,
+                                       description: "Path to the app file",
+                                       optional: true,
+                                       is_string: true,
+                                       default_value: default_file_path)
+        ]
+      end
+
+      def self.is_supported?(platform)
+        [:ios, :android].include?(platform)
+      end
+
+      def self.example_code
+        [
+          'perfecto',
+          'perfecto(
+            perfecto_cloudurl: ENV["PERFECTO_CLOUDURL"],
+            perfecto_token: ENV["PERFECTO_TOKEN"],
+            perfecto_media_location: ENV["PERFECTO_MEDIA_LOCATION"],
+            file_path: "path_to_apk_or_ipa_file"
+           )'
+        ]
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/perfecto/helper/perfecto_helper.rb

@@ -0,0 +1,45 @@
+require 'rest-client'
+require 'uri'
+require 'fastlane_core/ui/ui'
+require 'json'
+
+module Fastlane
+  UI = FastlaneCore::UI unless Fastlane.const_defined?("UI")
+
+  module Helper
+    class PerfectoHelper
+      # Uploads file to Perfecto
+      # Params :
+      # +perfecto_cloudurl+:: Perfecto's cloud name.
+      # +perfecto_token+:: Perfecto's security token.
+      # +file_path+:: Path to the file to be uploaded.
+      # +perfecto_media_fullpath+:: Path to the perfecto media location
+      def self.upload_file(perfecto_cloudurl, perfecto_token, file_path, perfecto_media_fullpath)
+        unless ENV['http_proxy']
+          RestClient.proxy = ENV['http_proxy']
+        end
+        response = RestClient::Request.execute(
+          url: 'https://' + perfecto_cloudurl + '/services/repositories/media/' + perfecto_media_fullpath + '?operation=upload&overwrite=true&securityToken=' + URI.encode(perfecto_token, "UTF-8"),
+          method: :post,
+          headers: {
+            'Accept' => 'application/json',
+            'Content-Type' => 'application/octet-stream',
+            'Expect' => '100-continue'
+          },
+          payload: File.open(file_path, "rb")
+        )
+        UI.message(response.inspect)
+      rescue RestClient::ExceptionWithResponse => err
+        begin
+          error_response = err.response.to_s
+        rescue
+          error_response = "Internal server error"
+        end
+        # Give error if upload failed.
+        UI.user_error!("App upload failed!!! Reason : #{error_response}")
+      rescue StandardError => error
+        UI.user_error!("App upload failed!!! Reason : #{error.message}")
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/perfecto/version.rb

@@ -0,0 +1,5 @@
+module Fastlane
+  module Perfecto
+    VERSION = "0.1.1"
+  end
+end

metadata

@@ -0,0 +1,195 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-perfecto
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Perfecto
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-01-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.49.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.49.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-require_tools
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fastlane
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.139.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.139.0
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+description: 
+email: support@perfectomobile.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/perfecto.rb
+- lib/fastlane/plugin/perfecto/actions/perfecto_action.rb
+- lib/fastlane/plugin/perfecto/helper/perfecto_helper.rb
+- lib/fastlane/plugin/perfecto/version.rb
+homepage: https://github.com/PerfectoMobileSA/fastlane-plugin-perfecto
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.4
+signing_key: 
+specification_version: 4
+summary: This plugin allows you to automatically upload ipa/apk files to Perfecto
+  for manual/automation testing
+test_files: []