pantograph 0.1.0

data/pantograph/lib/pantograph/actions/gradle.rb

@@ -0,0 +1,278 @@
+require 'pathname'
+require 'shellwords'
+
+module Pantograph
+  module Actions
+    module SharedValues
+      GRADLE_APK_OUTPUT_PATH = :GRADLE_APK_OUTPUT_PATH
+      GRADLE_ALL_APK_OUTPUT_PATHS = :GRADLE_ALL_APK_OUTPUT_PATHS
+      GRADLE_AAB_OUTPUT_PATH = :GRADLE_AAB_OUTPUT_PATH
+      GRADLE_ALL_AAB_OUTPUT_PATHS = :GRADLE_ALL_AAB_OUTPUT_PATHS
+      GRADLE_OUTPUT_JSON_OUTPUT_PATH = :GRADLE_OUTPUT_JSON_OUTPUT_PATH
+      GRADLE_ALL_OUTPUT_JSON_OUTPUT_PATHS = :GRADLE_ALL_OUTPUT_JSON_OUTPUT_PATHS
+      GRADLE_FLAVOR = :GRADLE_FLAVOR
+      GRADLE_BUILD_TYPE = :GRADLE_BUILD_TYPE
+    end
+
+    class GradleAction < Action
+      def self.run(params)
+        task = params[:task]
+        flavor = params[:flavor]
+        build_type = params[:build_type]
+
+        gradle_task = [task, flavor, build_type].join
+
+        project_dir = params[:project_dir]
+
+        gradle_path_param = params[:gradle_path] || './gradlew'
+
+        # Get the path to gradle, if it's an absolute path we take it as is, if it's relative we assume it's relative to the project_dir
+        gradle_path = if Pathname.new(gradle_path_param).absolute?
+                        File.expand_path(gradle_path_param)
+                      else
+                        File.expand_path(File.join(project_dir, gradle_path_param))
+                      end
+
+        # Ensure we ended up with a valid path to gradle
+        UI.user_error!("Couldn't find gradlew at path '#{File.expand_path(gradle_path)}'") unless File.exist?(gradle_path)
+
+        # Construct our flags
+        flags = []
+        flags << "-p #{project_dir.shellescape}"
+        flags << params[:properties].map { |k, v| "-P#{k.to_s.shellescape}=#{v.to_s.shellescape}" }.join(' ') unless params[:properties].nil?
+        flags << params[:system_properties].map { |k, v| "-D#{k.to_s.shellescape}=#{v.to_s.shellescape}" }.join(' ') unless params[:system_properties].nil?
+        flags << params[:flags] unless params[:flags].nil?
+
+        # Run the actual gradle task
+        gradle = Helper::GradleHelper.new(gradle_path: gradle_path)
+
+        # If these were set as properties, then we expose them back out as they might be useful to others
+        Actions.lane_context[SharedValues::GRADLE_BUILD_TYPE] = build_type if build_type
+        Actions.lane_context[SharedValues::GRADLE_FLAVOR] = flavor if flavor
+
+        # We run the actual gradle task
+        result = gradle.trigger(task: gradle_task,
+                                serial: params[:serial],
+                                flags: flags.join(' '),
+                                print_command: params[:print_command],
+                                print_command_output: params[:print_command_output])
+
+        # If we didn't build, then we return now, as it makes no sense to search for apk's in a non-`assemble` or non-`build` scenario
+        return result unless task =~ /\b(assemble)/ || task =~ /\b(bundle)/
+
+        apk_search_path = File.join(project_dir, '**', 'build', 'outputs', 'apk', '**', '*.apk')
+        aab_search_path = File.join(project_dir, '**', 'build', 'outputs', 'bundle', '**', '*.aab')
+        output_json_search_path = File.join(project_dir, '**', 'build', 'outputs', 'apk', '**', 'output.json')
+
+        # Our apk/aab is now built, but there might actually be multiple ones that were built if a flavor was not specified in a multi-flavor project (e.g. `assembleRelease`)
+        # However, we're not interested in unaligned apk's...
+        new_apks = Dir[apk_search_path].reject { |path| path =~ /^.*-unaligned.apk$/i }
+        new_apks = new_apks.map { |path| File.expand_path(path) }
+        new_aabs = Dir[aab_search_path]
+        new_aabs = new_aabs.map { |path| File.expand_path(path) }
+        new_output_jsons = Dir[output_json_search_path]
+        new_output_jsons = new_output_jsons.map { |path| File.expand_path(path) }
+
+        # We expose all of these new apks and aabs
+        Actions.lane_context[SharedValues::GRADLE_ALL_APK_OUTPUT_PATHS] = new_apks
+        Actions.lane_context[SharedValues::GRADLE_ALL_AAB_OUTPUT_PATHS] = new_aabs
+        Actions.lane_context[SharedValues::GRADLE_ALL_OUTPUT_JSON_OUTPUT_PATHS] = new_output_jsons
+
+        # We also take the most recent apk and aab to return as SharedValues::GRADLE_APK_OUTPUT_PATH and SharedValues::GRADLE_AAB_OUTPUT_PATH
+        # This is the one that will be relevant for most projects that just build a single build variant (flavor + build type combo).
+        # In multi build variants this value is undefined
+        last_apk_path = new_apks.sort_by(&File.method(:mtime)).last
+        last_aab_path = new_aabs.sort_by(&File.method(:mtime)).last
+        last_output_json_path = new_output_jsons.sort_by(&File.method(:mtime)).last
+        Actions.lane_context[SharedValues::GRADLE_APK_OUTPUT_PATH] = File.expand_path(last_apk_path) if last_apk_path
+        Actions.lane_context[SharedValues::GRADLE_AAB_OUTPUT_PATH] = File.expand_path(last_aab_path) if last_aab_path
+        Actions.lane_context[SharedValues::GRADLE_OUTPUT_JSON_OUTPUT_PATH] = File.expand_path(last_output_json_path) if last_output_json_path
+
+        # Give a helpful message in case there were no new apks or aabs. Remember we're only running this code when assembling, in which case we certainly expect there to be an apk or aab
+        UI.message('Couldn\'t find any new signed apk files...') if new_apks.empty? && new_aabs.empty?
+
+        return result
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        'All gradle related actions, including building and testing your Android app'
+      end
+
+      def self.details
+        'Run `./gradlew tasks` to get a list of all available gradle tasks for your project'
+      end
+
+      def self.available_options
+        [
+          PantographCore::ConfigItem.new(key: :task,
+                                       env_name: 'FL_GRADLE_TASK',
+                                       description: 'The gradle task you want to execute, e.g. `assemble`, `bundle` or `test`. For tasks such as `assembleMyFlavorRelease` you should use gradle(task: \'assemble\', flavor: \'Myflavor\', build_type: \'Release\')',
+                                       optional: false,
+                                       is_string: true),
+          PantographCore::ConfigItem.new(key: :flavor,
+                                       env_name: 'FL_GRADLE_FLAVOR',
+                                       description: 'The flavor that you want the task for, e.g. `MyFlavor`. If you are running the `assemble` task in a multi-flavor project, and you rely on Actions.lane_context[SharedValues::GRADLE_APK_OUTPUT_PATH] then you must specify a flavor here or else this value will be undefined',
+                                       optional: true,
+                                       is_string: true),
+          PantographCore::ConfigItem.new(key: :build_type,
+                                       env_name: 'FL_GRADLE_BUILD_TYPE',
+                                       description: 'The build type that you want the task for, e.g. `Release`. Useful for some tasks such as `assemble`',
+                                       optional: true,
+                                       is_string: true),
+          PantographCore::ConfigItem.new(key: :flags,
+                                       env_name: 'FL_GRADLE_FLAGS',
+                                       description: 'All parameter flags you want to pass to the gradle command, e.g. `--exitcode --xml file.xml`',
+                                       optional: true,
+                                       is_string: true),
+          PantographCore::ConfigItem.new(key: :project_dir,
+                                       env_name: 'FL_GRADLE_PROJECT_DIR',
+                                       description: 'The root directory of the gradle project',
+                                       default_value: '.',
+                                       is_string: true),
+          PantographCore::ConfigItem.new(key: :gradle_path,
+                                       env_name: 'FL_GRADLE_PATH',
+                                       description: 'The path to your `gradlew`. If you specify a relative path, it is assumed to be relative to the `project_dir`',
+                                       optional: true,
+                                       is_string: true),
+          PantographCore::ConfigItem.new(key: :properties,
+                                       env_name: 'FL_GRADLE_PROPERTIES',
+                                       description: 'Gradle properties to be exposed to the gradle script',
+                                       optional: true,
+                                       is_string: false),
+          PantographCore::ConfigItem.new(key: :system_properties,
+                                       env_name: 'FL_GRADLE_SYSTEM_PROPERTIES',
+                                       description: 'Gradle system properties to be exposed to the gradle script',
+                                       optional: true,
+                                       is_string: false),
+          PantographCore::ConfigItem.new(key: :serial,
+                                       env_name: 'FL_ANDROID_SERIAL',
+                                       description: 'Android serial, which device should be used for this command',
+                                       is_string: true,
+                                       default_value: ''),
+          PantographCore::ConfigItem.new(key: :print_command,
+                                       env_name: 'FL_GRADLE_PRINT_COMMAND',
+                                       description: 'Control whether the generated Gradle command is printed as output before running it (true/false)',
+                                       is_string: false,
+                                       default_value: true),
+          PantographCore::ConfigItem.new(key: :print_command_output,
+                                       env_name: 'FL_GRADLE_PRINT_COMMAND_OUTPUT',
+                                       description: 'Control whether the output produced by given Gradle command is printed while running (true/false)',
+                                       is_string: false,
+                                       default_value: true)
+        ]
+      end
+
+      def self.output
+        [
+          ['GRADLE_APK_OUTPUT_PATH', 'The path to the newly generated apk file. Undefined in a multi-variant assemble scenario'],
+          ['GRADLE_ALL_APK_OUTPUT_PATHS', 'When running a multi-variant `assemble`, the array of signed apk\'s that were generated'],
+          ['GRADLE_FLAVOR', 'The flavor, e.g. `MyFlavor`'],
+          ['GRADLE_BUILD_TYPE', 'The build type, e.g. `Release`'],
+          ['GRADLE_AAB_OUTPUT_PATH', 'The path to the most recent Android app bundle'],
+          ['GRADLE_ALL_AAB_OUTPUT_PATHS', 'The paths to the most recent Android app bundles'],
+          ['GRADLE_OUTPUT_JSON_OUTPUT_PATH', 'The path to the most recent output.json file'],
+          ['GRADLE_ALL_OUTPUT_JSON_OUTPUT_PATHS', 'The path to the newly generated output.json files']
+        ]
+      end
+
+      def self.return_value
+        'The output of running the gradle task'
+      end
+
+      def self.authors
+        ['KrauseFx', 'lmirosevic']
+      end
+
+      def self.is_supported?(platform)
+        [:ios, :android].include?(platform) # we support iOS as cross platforms apps might want to call `gradle` also
+      end
+
+      def self.example_code
+        [
+          'gradle(
+            task: "assemble",
+            flavor: "WorldDomination",
+            build_type: "Release"
+          )
+          ```
+
+          To build an AAB use:
+          ```ruby
+          gradle(
+            task: "bundle",
+            flavor: "WorldDomination",
+            build_type: "Release"
+          )
+          ```
+
+          You can pass properties to gradle:
+          ```ruby
+          gradle(
+            # ...
+
+            properties: {
+              "versionCode" => 100,
+              "versionName" => "1.0.0",
+              # ...
+            }
+          )
+          ```
+
+          You can use this to automatically [sign and zipalign](https://developer.android.com/studio/publish/app-signing.html) your app:
+          ```ruby
+          gradle(
+            task: "assemble",
+            build_type: "Release",
+            print_command: false,
+            properties: {
+              "android.injected.signing.store.file" => "keystore.jks",
+              "android.injected.signing.store.password" => "store_password",
+              "android.injected.signing.key.alias" => "key_alias",
+              "android.injected.signing.key.password" => "key_password",
+            }
+          )
+          ```
+
+          If you need to pass sensitive information through the `gradle` action, and don\'t want the generated command to be printed before it is run, you can suppress that:
+          ```ruby
+          gradle(
+            # ...
+            print_command: false
+          )
+          ```
+
+          You can also suppress printing the output generated by running the generated Gradle command:
+          ```ruby
+          gradle(
+            # ...
+            print_command_output: false
+          )
+          ```
+
+          To pass any other CLI flags to gradle use:
+          ```ruby
+          gradle(
+            # ...
+
+            flags: "--exitcode --xml file.xml"
+          )
+          ```
+
+          Delete the build directory, generated APKs and AABs
+          ```ruby
+          gradle(
+            task: "clean"
+          )'
+        ]
+      end
+
+      def self.category
+        :building
+      end
+    end
+  end
+end

data/pantograph/lib/pantograph/actions/import.rb

@@ -0,0 +1,49 @@
+module Pantograph
+  module Actions
+    class ImportAction < Action
+      def self.run(params)
+        # this is implemented in the pant_file.rb
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        "Import another Pantfile to use its lanes"
+      end
+
+      def self.details
+        [
+          "This is useful if you have shared lanes across multiple apps and you want to store a Pantfile in a separate folder.",
+          "The path must be relative to the Pantfile this is called from."
+        ].join("\n")
+      end
+
+      def self.available_options
+      end
+
+      def self.output
+        []
+      end
+
+      def self.authors
+        ["KrauseFx"]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+
+      def self.example_code
+        [
+          'import("./path/to/other/Pantfile")'
+        ]
+      end
+
+      def self.category
+        :misc
+      end
+    end
+  end
+end

data/pantograph/lib/pantograph/actions/import_from_git.rb

@@ -0,0 +1,71 @@
+module Pantograph
+  module Actions
+    class ImportFromGitAction < Action
+      def self.run(params)
+        # this is implemented in the pant_file.rb
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        "Import another Pantfile from a remote git repository to use its lanes"
+      end
+
+      def self.details
+        "This is useful if you have shared lanes across multiple apps and you want to store the Pantfile in a remote git repository."
+      end
+
+      def self.available_options
+        [
+          PantographCore::ConfigItem.new(key: :url,
+                                       description: "The URL of the repository to import the Pantfile from",
+                                       default_value: nil),
+          PantographCore::ConfigItem.new(key: :branch,
+                                       description: "The branch or tag to check-out on the repository",
+                                       default_value: 'HEAD',
+                                       optional: true),
+          PantographCore::ConfigItem.new(key: :path,
+                                       description: "The path of the Pantfile in the repository",
+                                       default_value: 'pantograph/Pantfile',
+                                       optional: true),
+          PantographCore::ConfigItem.new(key: :version,
+                                       description: "The version to checkout on the repository. Optimistic match operator or multiple conditions can be used to select the latest version within constraints",
+                                       default_value: nil,
+                                       is_string: false,
+                                       optional: true)
+        ]
+      end
+
+      def self.authors
+        ["fabiomassimo", "KrauseFx", "Liquidsoul"]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+
+      def self.example_code
+        [
+          'import_from_git(
+            url: "git@github.com:pantograph/pantograph.git", # The URL of the repository to import the Pantfile from.
+            branch: "HEAD", # The branch to checkout on the repository
+            path: "pantograph/Pantfile", # The path of the Pantfile in the repository
+            version: "~> 1.0.0" # The version to checkout on the repository. Optimistic match operator can be used to select the latest version within constraints.
+          )',
+          'import_from_git(
+            url: "git@github.com:pantograph/pantograph.git", # The URL of the repository to import the Pantfile from.
+            branch: "HEAD", # The branch to checkout on the repository
+            path: "pantograph/Pantfile", # The path of the Pantfile in the repository
+            version: [">= 1.1.0", "< 2.0.0"] # The version to checkout on the repository. Multiple conditions can be used to select the latest version within constraints.
+          )'
+        ]
+      end
+
+      def self.category
+        :misc
+      end
+    end
+  end
+end

data/pantograph/lib/pantograph/actions/is_ci.rb

@@ -0,0 +1,51 @@
+module Pantograph
+  module Actions
+    class IsCiAction < Action
+      def self.run(params)
+        Helper.ci?
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        "Is the current run being executed on a CI system, like Jenkins or Travis"
+      end
+
+      def self.details
+        "The return value of this method is true if pantograph is currently executed on Travis, Jenkins, Circle or a similar CI service"
+      end
+
+      def self.available_options
+        []
+      end
+
+      def self.return_type
+        :bool
+      end
+
+      def self.authors
+        ["KrauseFx"]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+
+      def self.example_code
+        [
+          'if is_ci?
+            puts "I\'m a computer"
+          else
+            say "Hi Human!"
+          end'
+        ]
+      end
+
+      def self.category
+        :misc
+      end
+    end
+  end
+end

data/pantograph/lib/pantograph/actions/jira.rb

@@ -0,0 +1,115 @@
+module Pantograph
+  module Actions
+    class JiraAction < Action
+      def self.run(params)
+        Actions.verify_gem!('jira-ruby')
+        require 'jira-ruby'
+
+        site         = params[:url]
+        auth_type    = :basic
+        context_path = params[:context_path]
+        username     = params[:username]
+        password     = params[:password]
+        ticket_id    = params[:ticket_id]
+        comment_text = params[:comment_text]
+
+        options = {
+                    site: site,
+                    context_path: context_path,
+                    auth_type: auth_type,
+                    username: username,
+                    password: password
+                  }
+
+        client = JIRA::Client.new(options)
+        issue = client.Issue.find(ticket_id)
+        comment = issue.comments.build
+        comment.save({ 'body' => comment_text })
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        "Leave a comment on JIRA tickets"
+      end
+
+      def self.available_options
+        [
+          PantographCore::ConfigItem.new(key: :url,
+                                      env_name: "FL_JIRA_SITE",
+                                      description: "URL for Jira instance",
+                                       verify_block: proc do |value|
+                                         UI.user_error!("No url for Jira given, pass using `url: 'url'`") if value.to_s.length == 0
+                                       end),
+          PantographCore::ConfigItem.new(key: :context_path,
+                                      env_name: "FL_JIRA_CONTEXT_PATH",
+                                      description: "Appends to the url (ex: \"/jira\")",
+                                      optional: true,
+                                      default_value: ""),
+          PantographCore::ConfigItem.new(key: :username,
+                                       env_name: "FL_JIRA_USERNAME",
+                                       description: "Username for JIRA instance",
+                                       verify_block: proc do |value|
+                                         UI.user_error!("No username") if value.to_s.length == 0
+                                       end),
+          PantographCore::ConfigItem.new(key: :password,
+                                       env_name: "FL_JIRA_PASSWORD",
+                                       description: "Password for Jira",
+                                       sensitive: true,
+                                       verify_block: proc do |value|
+                                         UI.user_error!("No password") if value.to_s.length == 0
+                                       end),
+          PantographCore::ConfigItem.new(key: :ticket_id,
+                                       env_name: "FL_JIRA_TICKET_ID",
+                                       description: "Ticket ID for Jira, i.e. IOS-123",
+                                       verify_block: proc do |value|
+                                         UI.user_error!("No Ticket specified") if value.to_s.length == 0
+                                       end),
+          PantographCore::ConfigItem.new(key: :comment_text,
+                                       env_name: "FL_JIRA_COMMENT_TEXT",
+                                       description: "Text to add to the ticket as a comment",
+                                       verify_block: proc do |value|
+                                         UI.user_error!("No comment specified") if value.to_s.length == 0
+                                       end)
+        ]
+      end
+
+      def self.return_value
+      end
+
+      def self.authors
+        ["iAmChrisTruman"]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+
+      def self.example_code
+        [
+          'jira(
+            url: "https://bugs.yourdomain.com",
+            username: "Your username",
+            password: "Your password",
+            ticket_id: "Ticket ID, i.e. IOS-123",
+            comment_text: "Text to post as a comment"
+          )',
+          'jira(
+            url: "https://yourserverdomain.com",
+            context_path: "/jira",
+            username: "Your username",
+            password: "Your password",
+            ticket_id: "Ticket ID, i.e. IOS-123",
+            comment_text: "Text to post as a comment"
+          )'
+        ]
+      end
+
+      def self.category
+        :misc
+      end
+    end
+  end
+end

data/pantograph/lib/pantograph/actions/lane_context.rb

@@ -0,0 +1,60 @@
+module Pantograph
+  module Actions
+    class LaneContextAction < Action
+      def self.run(params)
+        Actions.lane_context
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        "Access lane context values"
+      end
+
+      def self.details
+        [
+          "Access the pantograph lane context values.",
+          "More information about how the lane context works: [https://docs.pantograph.tools/advanced/#lane-context](https://docs.pantograph.tools/advanced/#lane-context)."
+        ].join("\n")
+      end
+
+      def self.available_options
+        []
+      end
+
+      def self.output
+        []
+      end
+
+      def self.return_type
+        :hash
+      end
+
+      def self.authors
+        ["KrauseFx"]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+
+      # We don't want to show this as step
+      def self.step_text
+        nil
+      end
+
+      def self.example_code
+        [
+          'lane_context[SharedValues::BUILD_NUMBER]',
+          'lane_context[SharedValues::IPA_OUTPUT_PATH]'
+        ]
+      end
+
+      def self.category
+        :misc
+      end
+    end
+  end
+end

data/pantograph/lib/pantograph/actions/last_git_commit.rb

@@ -0,0 +1,58 @@
+module Pantograph
+  module Actions
+    class LastGitCommitAction < Action
+      def self.run(params)
+        Actions.last_git_commit_dict
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        "Return last git commit hash, abbreviated commit hash, commit message and author"
+      end
+
+      def self.return_value
+        "Returns the following dict: {commit_hash: \"commit hash\", abbreviated_commit_hash: \"abbreviated commit hash\" author: \"Author\", author_email: \"author email\", message: \"commit message\"}"
+      end
+
+      def self.return_type
+        :hash_of_strings
+      end
+
+      def self.author
+        "ngutman"
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+
+      def self.example_code
+        [
+          'commit = last_git_commit
+          crashlytics(notes: commit[:message]) # message of commit
+          author = commit[:author] # author of the commit
+          author_email = commit[:author_email] # email of the author of the commit
+          hash = commit[:commit_hash] # long sha of commit
+          short_hash = commit[:abbreviated_commit_hash] # short sha of commit'
+        ]
+      end
+
+      def self.category
+        :source_control
+      end
+
+      def self.sample_return_value
+        {
+          message: "message",
+          author: "author",
+          author_email: "author_email",
+          commit_hash: "commit_hash",
+          abbreviated_commit_hash: "short_hash"
+        }
+      end
+    end
+  end
+end