trent 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8bf0702ce2c0fff153f326fd2f975aed86e42d6fd2fc3ea1bc09f9264f40fca3
-  data.tar.gz: 0b43ac26659e0032f9def1b7d6090acf8587357e3b2074136d5bb72aa0e2acab
+  metadata.gz: 0c24028242dbee5242968caf0debba171505838ed9ea679f67c1a45080bba48d
+  data.tar.gz: 4e08149c17144b39350bfce96733a7efe0f53d77b66383700bf81a743a7b390d
 SHA512:
-  metadata.gz: 58437bb5955c6b6f89b546aec964f423696d7a177ba88bd644611cd84a5c22aee0820d218432e4cd206e709e79b8afc1a01769a8e0e6cd2dadfe98a8662d18f3
-  data.tar.gz: '097c6e79bfe8c9fdcffcc06b35aff26e9db37167915462886c5ee4e72bf5186047e6ac9bb5afd8db0e1320e201152e4413eb16b70be5747056582158fdf74225'
+  metadata.gz: b7b9184aae962c908747e33a35482d8c7f470c52dd5fd9ea9f249fc0f0d6fca2edf4e863d670fa9e116691f56d94d4dd33a0513671e3bd730ca26c712318798c
+  data.tar.gz: dab47c51d9b65bc25753d91b2ad6507e893809f50a7e16e4844f9a22c651798a5387425cea9c8139cf9a9268c0933c4ee615dd3f2e28ecee792cbe6322956843

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+### [0.4.0] 2019-03-07
+
+### Added
+- Add small set of utility functions for Travis-CI. Specifically determining if the previous branch build for a pull request was successful or not. [Discussion](https://github.com/levibostian/Trent/issues/22)
+
 ### [0.3.0] 2018-11-27
 
 ### Added

data/README.md

@@ -4,7 +4,7 @@
 
 # Trent
 
-Run and debug bash commands on Travis-CI much easier.
+Run and debug bash commands on Travis-CI much easier. Make writing commands to run on your CI not painful. 
 
 ...Yes, Trent is open to working with more then Travis-CI. At this time, Travis is what I use so it's what's supported. Make a pull request to add more. 
 
@@ -148,6 +148,34 @@ ci.config_github('wfoweifwoeifjweoijwefowefweoif')
 ci.github.comment("Tests pass!") # Send comment to pull request for the Travis build. The pull request information is automatically retrieved from the Travis virtual machine the build is running on. 
 ```
 
+# Travis 
+
+Trent comes with some handy commands that allow you to work with Travis, itself, easily. Here are some things you can do with it: 
+
+### Skip rest of Trent commands if previous branch build failed and on a pull request 
+
+When I am working on a project and I get it done, I tend to push up my branch to GitHub and then make a pull request right away to indicate it is complete. 
+
+The problem is, if my branch build fails, the pull request build on Travis will still happen (and most likely fail if configured similar to my push commands). I would rather have Travis skip running some commands on a pull request build if the previous branch build failed. 
+
+```ruby
+require 'trent'
+
+ci = Trent.new()
+# Set Travis CI API key to authenticate user account. 
+# Log into travis-ci.com or travis-ci.org (depending on where your repo is located), and browse to your profile page: https://travis-ci.com/account/preferences Copy the API key shown. 
+# I like to store this API key in an environment variable. 
+# Also indicate if this is a private repo or not. 
+ci.config_travis(:api_key => ENV["TRAVIS_API_KEY"], :private_repo => true)
+
+if TravisCI.pull_request? && ci.travis.branch_build_successful?
+  # Do something if we are in a pull request and the most recent branch build was successful. 
+end 
+
+# Or, fail is Trent figures out we are in a pull request and the most recent branch build was not successful. 
+ci.travis.fail_if_pr_branch_build_failed()
+```
+
 # Docs
 
 Trent documentation is hosted [here](https://www.rubydoc.info/gems/trent/0.1.0). 
@@ -170,6 +198,8 @@ ci = Trent.new(:color => :green)
 
 Trent is open for pull requests. Check out the [list of issues](https://github.com/levibostian/trent/issues) for tasks I am planning on working on. Check them out if you wish to contribute in that way.
 
+At this time, Trent is a random collection of random tasks that I have found a use case for while working with CI servers. I see Trent being more of a core system that can run a series of plugins for you. I want to think of it as "The [Danger](https://danger.systems/) of creating scripts for CI servers" (aka: a convenience tool to help you write scripts quickly and painless with less bugs). 
+
 **Want to add features to Trent?** Before you decide to take a bunch of time and add functionality to the library, please, [create an issue](https://github.com/levibostian/trent/issues/new) stating what you wish to add. This might save you some time in case your purpose does not fit well in the use cases of Trent.
 
 ### Building Trent 

data/lib/travis/travis.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require 'travis'
+require 'travis/pro' # For private repos
+require_relative '../log'
+
+# Functions to run on Travis
+class TravisCI
+  def initialize(params = {})
+    Log.fatal('Cannot run commands against Travis when not running on a Travis server') unless TravisCI.running_on_travis?
+
+    @private = params.fetch(:private_repo, false)
+    @travis_token = params.fetch(:api_key)
+
+    authenticate
+  end
+
+  # If currently running on a Travis CI machine
+  def self.running_on_travis?
+    ENV['HAS_JOSH_K_SEAL_OF_APPROVAL']
+  end
+
+  # If CI job running on a pull request
+  def self.pull_request?
+    ENV['TRAVIS_PULL_REQUEST'].to_s == 'true'
+  end
+
+  # If the current job is a pull request, this will determine if the previous build for the current branch was successful or not.
+  # Note: An exception will be thrown if not in a pull request.
+  def branch_build_successful?
+    Log.fatal('Cannot determine if branch build was successful if not running on a pull request') unless TravisCI.pull_request?
+
+    travis_repo = repo
+    original_branch = ENV['TRAVIS_PULL_REQUEST_BRANCH']
+
+    travis_repo.branch(original_branch).green?
+  end
+
+  # Get repository from Travis
+  def repo
+    if @private
+      Travis::Pro::Repository.find(ENV['TRAVIS_REPO_SLUG'])
+    else
+      Travis::Repository.find(ENV['TRAVIS_REPO_SLUG'])
+    end
+  end
+
+  # If the previous build on current branch failed on Travis, skip this build too.
+  def fail_if_pr_branch_build_failed
+    return unless TravisCI.pull_request?
+
+    Log.warning('Checking if previous build for this branch was successful on Travis...')
+
+    Log.fatal('Skipping running command because previous build for branch failed.') unless branch_build_successful?
+  end
+
+  private
+
+  def authenticate
+    if @private
+      Travis::Pro.access_token = @travis_token
+    else
+      Travis.access_token = @travis_token
+    end
+  end
+end

data/lib/trent.rb

@@ -2,6 +2,7 @@
 
 require 'command/ssh/ssh'
 require 'github/github'
+require 'travis/travis'
 require 'command/sh/sh'
 require 'colorize'
 require_relative './log'
@@ -14,7 +15,7 @@ class Trent
   # local - Run Trent locally on your own machine instead of a CI server.
   def initialize(params = {})
     running_local = params.fetch(:local, false)
-    Log.fatal('Trent is designed to run on Travis-CI builds. Run it on Travis-CI.') unless ENV['HAS_JOSH_K_SEAL_OF_APPROVAL'] || running_local
+    Log.fatal('Trent is designed to run on Travis-CI builds. Run it on Travis-CI.') unless TravisCI.running_on_travis? || running_local
 
     @color = params.fetch(:color, :blue)
     @sh = Sh.new
@@ -32,6 +33,11 @@ class Trent
     @github = GitHub.new(api_key)
   end
 
+  # Configure how to communicate with Travis
+  def config_travis(api_key, private_repo)
+    @travis = TravisCI.new(api_key: api_key, private_repo: private_repo)
+  end
+
   # While working with bash commands, some commands are not added to the path. That's annoying.
   # Convenient method to assign a command to a path for replacing.
   # Example:
@@ -65,6 +71,12 @@ class Trent
     result
   end
 
+  # Get instance of GitHub class to run commands against GitHub
+  def travis
+    Log.fatal('You did not configure Travis yet.') unless @travis
+    @travis
+  end
+
   # Get instance of GitHub class to run commands against GitHub
   def github
     Log.fatal('You did not configure GitHub yet.') unless @github

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: trent
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Levi Bostian
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-27 00:00:00.000000000 Z
+date: 2019-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -50,6 +50,26 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 5.0.2
+- !ruby/object:Gem::Dependency
+  name: travis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.2
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -149,6 +169,7 @@ files:
 - lib/command/ssh/ssh.rb
 - lib/github/github.rb
 - lib/log.rb
+- lib/travis/travis.rb
 - lib/trent.rb
 homepage: http://github.com/levibostian/trent
 licenses: