fastlane-plugin-queue 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cdacfd6b25670d732c568e5dc5241b3a13e8fe61
+  data.tar.gz: cad53d3beab7cd475c7e8ef71856783d7ac15e8f
+SHA512:
+  metadata.gz: f78af491b790c137cdeb17e3f6cd1423309113bc4e09143c02a0bd9df17a23ac54523bb1938aedb2f98f780585dea8295ac41bac128b2d89bc1b32d55a32a567
+  data.tar.gz: 99cbe8c10c7cd7e2920b58ab3a6338e96f64dde1af8f15230834b05bfea8e576ef42b2ba2721dda188425252bedb5b42e6490f5ae9f42e7c5e0001c1ac2e077c

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Josh Holtz <josh@rokkincat.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,123 @@
+# fastlane-plugin-queue
+
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-queue)
+
+## About fastlane-plugin-queue
+
+Easily queue up `fastlane` jobs using [Resque](https://github.com/resque/resque).
+
+### Current Features
+- Queue any of your lanes into a `resque` queue
+- Manage queue using `resque`'s web interface
+  - View queued, running, and failed jobs
+  - Retry failed jobs
+
+### Planned Features
+- Configure any `resque` settings 
+  - Ex: port, redis connection settings, plugins
+- Custom web interface for starting `fastlane` jobs
+- Allow different `dotenv` settings per job
+
+![Screenshot - Overview](screenshots/screenshot_overview.png)
+
+## Getting Started
+
+This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-queue`, add it to your project by running:
+
+```bash
+fastlane add_plugin queue
+```
+
+This plugin also require [Redis](https://redis.io). Install using `brew install redis` or instructions [here](https://redis.io/download)
+
+### Step 0 - Start Redis server
+Make sure you Redis server is running. This is usually done by running `redis-server` (but this may be different based on how Redis was installed).
+
+### Step 1 - Start queue
+Start the queue web server and worker by running the following command. This will be a **blocking** command so you will need to open to open a second terminal window/tab to add your fastlane jobs to the queue. To kill the web server and worker, you will need to hit `CONTROL + C`.
+```rb
+fastlane run start_queue
+```
+
+### Step 2 - Add to queue
+The easiest way to add a job to a queue is to run the `queue` action direction using the following command. The `run` parameter will run anything you would put after the "fastlane" command you would usually run. Below are some examples:
+```rb
+fastlane run queue run:"ios deploy"
+```
+
+```rb
+fastlane run queue run:"android deploy"
+```
+
+```rb
+fastlane run queue run:"build"
+```
+
+```rb
+fastlane run queue run:"ios beta group:staging"
+```
+
+## Advanced
+It is possible add fastlane jobs to your queue by using standard fastlane syntax by adding `queue:true` (see below)
+
+```sh
+fastlane ios beta queue:true
+```
+
+To do this, add the following setup in your `Fastfile`...
+
+```rb
+before_all do |lane, options|
+  if options[:queue]
+    queue(
+      platform: Actions.lane_context[Actions::SharedValues::PLATFORM_NAME],
+      lane: lane.to_s,
+      lane_parameters: options
+    )
+    UI.abort_with_message! "We queued this so not running"
+  end
+end
+```
+
+This will abort the fastlane process before any of the lanes can get called but **will** add a job to the queue platform, lane, and parameters that you specified in your command.
+
+## Example Resque Screenshots
+
+|Resque Screen|Screenshot|
+|---|---|
+|Overview|![Screenshot - Overview](screenshots/screenshot_overview.png)|
+|Pending|![Screenshot - Pending](screenshots/screenshot_pending.png)|
+|Failed|![Screenshot - Failed](screenshots/screenshot_failed.png)|
+
+## 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`.
+
+## 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.
+
+## Using _fastlane_ Plugins
+
+For more information about how the `fastlane` plugin system works, check out the [Plugins documentation](https://docs.fastlane.tools/plugins/create-plugin/).
+
+## 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/queue/actions/queue_action.rb

@@ -0,0 +1,72 @@
+require 'resque'
+
+module Fastlane
+  module Actions
+    class QueueAction < Action
+      def self.run(params)
+        # Should be value like "<platform> <lane> <parameters...>"
+        # Ex: "ios build environment:production"
+        # Usage: fastlane run queue run:"ios build environment:production"
+        run = params[:run]
+
+        # These values come in from running the queue action in a Fastfile
+        platform = params[:platform]
+        lane = params[:lane]
+        lane_parameters = params[:lane_parameters]
+
+        if lane_parameters
+          lane_parameters['queue'] = nil
+          lane_parameters[:queue] = nil
+        end
+
+        Resque.enqueue(Job, {
+          'run' => run,
+          'platform' => platform,
+          'lane' => lane,
+          'lane_parameters' => lane_parameters
+          })
+      end
+
+      def self.description
+        "Adds fastlane jobs to a queue"
+      end
+
+      def self.authors
+        ["Josh Holtz"]
+      end
+
+      def self.return_value
+        # If your method provides a return value, you can describe here what it does
+      end
+
+      def self.details
+        "Adds fastlane jobs to a Resque queue"
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :run,
+                               description: "Run that stuff",
+                                  optional: true,
+                                      type: String),
+          FastlaneCore::ConfigItem.new(key: :platform,
+                               description: "Run that stuff",
+                                  optional: true,
+                                      type: String),
+          FastlaneCore::ConfigItem.new(key: :lane,
+                               description: "Run that stuff",
+                                  optional: true,
+                                      type: String),
+          FastlaneCore::ConfigItem.new(key: :lane_parameters,
+                               description: "Run that stuff",
+                                  optional: true,
+                                      type: Hash)
+        ]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/queue/actions/queue_start_action.rb

@@ -0,0 +1,59 @@
+module Fastlane
+  module Actions
+    class QueueStartAction < Action
+      def self.run(params)
+        UI.message("Starting the queue's web server and worker!")
+
+        # Gotta do the fork thing
+        # Otherwise this process will block the worker from starting
+        # This can get called  multiple times and only one server will be run
+        Process.fork do
+          require 'vegas'
+          require 'resque/server'
+          Vegas::Runner.new(Resque::Server, 'fastlane-plugin-queue-resque-web')
+        end
+
+        # Starts a blocking worker
+        require 'resque'
+        worker = Resque::Worker.new("fastlane")
+        worker.prepare
+        worker.log "Starting worker #{self}"
+        worker.work(5) # interval, will block
+
+        # Stops the queue and webserver
+        other_action.queue_stop
+      end
+
+      def self.description
+        "Starts web server and worker for queueing fastlane jobs"
+      end
+
+      def self.authors
+        ["Josh Holtz"]
+      end
+
+      def self.return_value
+        # This action will NEVER return because the worker is blocking
+      end
+
+      def self.details
+        "Starts a Resque web server and worker for queueing fastlane jobs"
+      end
+
+      def self.available_options
+        # No options right now but probably allow Resque options to be set
+        [
+          # FastlaneCore::ConfigItem.new(key: :your_option,
+          #                         env_name: "QUEUE_YOUR_OPTION",
+          #                      description: "A description of your option",
+          #                         optional: false,
+          #                             type: String)
+        ]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/queue/actions/queue_stop_action.rb

@@ -0,0 +1,60 @@
+module Fastlane
+  module Actions
+    class QueueStopAction < Action
+      def self.run(params)
+        UI.message("Stopping the queue's web server and worker!")
+
+        # I feel bad about this but need to kill the process of the worker
+        # and shutdown the worker and prunce dead workers from showing
+        # in the Resque web interface
+        require 'resque'
+        begin
+          Resque::Worker.all.each do |worker|
+            begin
+              Process.kill("KILL", worker.pid)
+            rescue StandardError
+              true
+            end
+            worker.shutdown!
+            worker.prune_dead_workers
+          end
+        rescue StandardError
+          UI.warning("Nothing to stop")
+        end
+
+        # Shut down our web server
+        begin
+          require 'vegas'
+          require 'resque/server'
+          Vegas::Runner.new(Resque::Server, 'fastlane-plugin-queue-resque-web', {}, ["--kill"])
+        rescue StandardError
+          UI.warning("Nothing to stop")
+        end
+      end
+
+      def self.description
+        "Stops web server and worker for queueing fastlane jobs"
+      end
+
+      def self.authors
+        ["Josh Holtz"]
+      end
+
+      def self.return_value
+        # No return value right now
+      end
+
+      def self.details
+        "Stops a Resque web server and worker for queueing fastlane jobs"
+      end
+
+      def self.available_options
+        # No options right now
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/queue/helper/job.rb

@@ -0,0 +1,26 @@
+class MockOptions
+  attr_accessor :env
+end
+
+class Job
+  @queue = :fastlane
+
+  def self.perform(params)
+    run = params['run']
+
+    platform = params['platform']
+    lane = params['lane']
+    lane_parameters = params['lane_parameters']
+
+    if run
+      args = run.split(' ')
+      Fastlane::CommandLineHandler.handle(args, MockOptions.new)
+    else
+      platform = nil if platform.to_s.size == 0
+      lane_parameters = lane_parameters.each_with_object({}) { |(k, v), memo| memo[k.to_sym] = v; }
+
+      dot_env = nil
+      Fastlane::LaneManager.cruise_lane(platform, lane, lane_parameters, dot_env)
+    end
+  end
+end

data/lib/fastlane/plugin/queue/helper/queue_helper.rb

@@ -0,0 +1,12 @@
+module Fastlane
+  module Helper
+    class QueueHelper
+      # class methods that you define here become available in your action
+      # as `Helper::QueueHelper.your_method`
+      #
+      def self.show_message
+        UI.message("Hello from the queue plugin helper!")
+      end
+    end
+  end
+end

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

@@ -0,0 +1,5 @@
+module Fastlane
+  module Queue
+    VERSION = "0.1.0"
+  end
+end

data/lib/fastlane/plugin/queue.rb

@@ -0,0 +1,16 @@
+require 'fastlane/plugin/queue/version'
+
+module Fastlane
+  module Queue
+    # 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::Queue.all_classes.each do |current|
+  require current
+end

data/lib/tasks/resque.rake

@@ -0,0 +1,2 @@
+$LOAD_PATH.unshift File.dirname(__FILE__) + '/../../lib'
+require 'resque/tasks'

metadata

@@ -0,0 +1,180 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-queue
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Josh Holtz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-10-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: resque
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.27'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.27'
+- !ruby/object:Gem::Dependency
+  name: vegas
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !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: fastlane
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.53.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.53.0
+- !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: 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: 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: rubocop
+  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'
+description: 
+email: josh@rokkincat.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/queue.rb
+- lib/fastlane/plugin/queue/actions/queue_action.rb
+- lib/fastlane/plugin/queue/actions/queue_start_action.rb
+- lib/fastlane/plugin/queue/actions/queue_stop_action.rb
+- lib/fastlane/plugin/queue/helper/job.rb
+- lib/fastlane/plugin/queue/helper/queue_helper.rb
+- lib/fastlane/plugin/queue/version.rb
+- lib/tasks/resque.rake
+homepage: 
+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: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: Queue up fastlane jobs
+test_files: []
+has_rdoc: