fa-harness-tools 1.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a3cee0250f6a943fb938d11c0e118f53d26ea03be5edb7e8f8fc7fb0f73e154e
+  data.tar.gz: 030ab9dac48945eac8366a8cfcbafecc4bbbeebc5dc16254f97bfa3cfdb26368
+SHA512:
+  metadata.gz: 3f00171760572605f0282595bc852bf20181768464dd9811051cb71a6658daa9692bdb77c46dbb180eca6c982b17736cf0f4c24e89cf6fba60fcddd379d81a08
+  data.tar.gz: 863db5b6b4230a1d2fedd00ab20f05d830fb682bc9b4947f1e4bdd69429dfa90ba637fac2afabd6cd7c8c7b71271e6a53346593325e46a0c7c6377453c86e7bd

data/.github/workflows/ruby.yml

@@ -0,0 +1,20 @@
+name: Ruby
+
+on: [push, pull_request]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v1
+    - name: Set up Ruby 2.5
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.5.x
+    - name: Build and test with Rake
+      run: |
+        gem install bundler -v 1.16.4
+        bundle install --jobs 4 --retry 3
+        bundle exec rake

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+2.5.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,77 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to make participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies within all project spaces, and it also applies when
+an individual is representing the project or its community in public spaces.
+Examples of representing a project or community include using an official
+project e-mail address, posting via an official social media account, or acting
+as an appointed representative at an online or offline event. Representation of
+a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at [INSERT EMAIL ADDRESS]. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq
+

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in fa-harness-tools.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,56 @@
+PATH
+  remote: .
+  specs:
+    fa-harness-tools (1.0.4)
+      octokit (~> 4.0)
+      tzinfo (~> 2.0)
+      tzinfo-data (~> 1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    concurrent-ruby (1.1.5)
+    diff-lcs (1.3)
+    faraday (0.17.0)
+      multipart-post (>= 1.2, < 3)
+    multipart-post (2.1.1)
+    octokit (4.14.0)
+      sawyer (~> 0.8.0, >= 0.5.3)
+    public_suffix (4.0.1)
+    rake (10.5.0)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.0)
+      rspec-support (~> 3.9.0)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.0)
+    sawyer (0.8.2)
+      addressable (>= 2.3.5)
+      faraday (> 0.8, < 2.0)
+    timecop (0.9.1)
+    tzinfo (2.0.0)
+      concurrent-ruby (~> 1.0)
+    tzinfo-data (1.2019.3)
+      tzinfo (>= 1.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0)
+  fa-harness-tools!
+  rake (~> 10.0)
+  rspec (~> 3.8)
+  timecop (~> 0.9)
+
+BUNDLED WITH
+   1.16.4

data/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,105 @@
+# fa-harness-tools
+
+FreeAgent-specific pre-flight checks and tools that are designed to work in [Harness](https://harness.io).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'fa-harness-tools'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fa-harness-tools
+
+## Usage
+
+Examples below use [variables defined by Harness](https://docs.harness.io/article/9dvxcegm90-variables) so should be suitable to use directly in Harness scripts.
+
+### Required environment variables
+
+* `GITHUB_OAUTH_TOKEN` must be exported, containing a valid [personal access token](https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line) for GitHub
+
+### check-branch-brotection
+
+Check the new build/commit being deployed is on the master branch:
+
+```
+bundle exec exe/check-branch-protection -r ${artifact.source.repositoryName} -e ${env.name} -b ${artifact.buildNo}
+```
+
+(Branch name etc can be changed, see `--help` for more options.)
+
+### check-forward-deploy
+
+Using a Git tag indicating the last deployment, check that the new commit being deployed is a descendant of the current commit:
+
+```
+bundle exec exe/check-forward-deploy -r ${artifact.source.repositoryName} -e ${env.name} -b ${artifact.buildNo}
+```
+
+(Tag prefix etc can be changed, see `--help` for more options.)
+
+### check-recent-deploy
+
+Using Git tags indicating recent deployments, check the commit being deployed is one of the last X commits or newer. Allows a user to rollback by X deployments.
+
+```
+bundle exec exe/check-recent-deploy -r ${artifact.source.repositoryName} -e ${env.name} -b ${artifact.buildNo}
+```
+
+(Allowed rollback count and tag prefix etc can be changed, see `--help` for more options.)
+
+### check-schedule
+
+Check the current time is within the deployment window of Mon-Thu 9am to 4pm, or Fri 9am to 12pm, using local London time.
+
+```
+bundle exec exe/check-schedule
+```
+
+### create-deployment-tag
+
+Creates a Git tag in the project repository to indicate the deployment has happened:
+
+```
+bundle exec exe/create-deployment-tag -r ${artifact.source.repositoryName} -e ${env.name} -b ${artifact.buildNo}
+```
+
+(Tagger's name and email address etc can be changed, see `--help` for more options.)
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+To release a new version, update the version number in `version.rb`, run `bundle` and commit the version bump. Then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+The Ruby version used matches the one from the `harness/delegate` Docker image.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/fac/fa-harness-tools
+
+## Licence
+
+Copyright 2019 FreeAgent Central Ltd.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+  task :default => :spec
+rescue LoadError
+  # no rspec available
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "fa-harness-tools"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/check-branch-protection

@@ -0,0 +1,57 @@
+#!/usr/bin/env ruby
+
+require "fa-harness-tools"
+require "optparse"
+
+options = {
+  github_owner: "fac",
+  branch: "master",
+}
+OptionParser.new do |opts|
+  opts.banner = "Usage: check-branch-protection [options]"
+
+  opts.on("--branch NAME", "Git branch to verify this deployed commit is on, defaults to 'master'") do |v|
+    options[:branch] = v
+  end
+
+  opts.on("-b", "--build-no REVISION", "Build number/deployment revision") do |v|
+    options[:build_no] = v
+  end
+
+  opts.on("-e", "--environment NAME", "Environment name") do |v|
+    options[:environment] = v
+  end
+
+  opts.on("--github-owner NAME", "GitHub organisation/owner name, defaults to 'fac'") do |v|
+    options[:github_owner] = v
+  end
+
+  opts.on("-r", "--repository NAME", "GitHub repository name") do |v|
+    options[:repo] = v
+  end
+end.parse!
+
+client = FaHarnessTools::GithubClient.new(
+  oauth_token: ENV.fetch("GITHUB_OAUTH_TOKEN"),
+  owner: options.fetch(:github_owner),
+  repo: options.fetch(:repo),
+)
+context = FaHarnessTools::HarnessContext.new(
+  client: client,
+  environment: options.fetch(:environment),
+  build_no: options.fetch(:build_no),
+)
+
+result = FaHarnessTools::CheckBranchProtection.new(
+  client: client,
+  context: context,
+  branch: options.fetch(:branch),
+).verify?
+
+if result.first
+  puts result.last
+  exit 0
+else
+  $stderr.puts result.last
+  exit 1
+end

data/exe/check-forward-deploy

@@ -0,0 +1,57 @@
+#!/usr/bin/env ruby
+
+require "fa-harness-tools"
+require "optparse"
+
+options = {
+  github_owner: "fac",
+  tag_prefix: "harness-deploy",
+}
+OptionParser.new do |opts|
+  opts.banner = "Usage: check-forward-deploy [options]"
+
+  opts.on("-b", "--build-no REVISION", "Build number/deployment revision") do |v|
+    options[:build_no] = v
+  end
+
+  opts.on("-e", "--environment NAME", "Environment name") do |v|
+    options[:environment] = v
+  end
+
+  opts.on("--github-owner NAME", "GitHub organisation/owner name, defaults to 'fac'") do |v|
+    options[:github_owner] = v
+  end
+
+  opts.on("-r", "--repository NAME", "GitHub repository name") do |v|
+    options[:repo] = v
+  end
+
+  opts.on("--tag-prefix PREFIX", "Git tag prefix, defaults to 'harness-deploy'") do |v|
+    options[:tag_prefix] = v
+  end
+end.parse!
+
+client = FaHarnessTools::GithubClient.new(
+  oauth_token: ENV.fetch("GITHUB_OAUTH_TOKEN"),
+  owner: options.fetch(:github_owner),
+  repo: options.fetch(:repo),
+)
+context = FaHarnessTools::HarnessContext.new(
+  client: client,
+  environment: options.fetch(:environment),
+  build_no: options.fetch(:build_no),
+)
+
+result = FaHarnessTools::CheckForwardDeploy.new(
+  client: client,
+  context: context,
+  tag_prefix: options.fetch(:tag_prefix),
+).verify?
+
+if result.first
+  puts result.last
+  exit 0
+else
+  $stderr.puts result.last
+  exit 1
+end

data/exe/check-recent-deploy

@@ -0,0 +1,63 @@
+#!/usr/bin/env ruby
+
+require "fa-harness-tools"
+require "optparse"
+
+options = {
+  allowed_rollback_count: 3,
+  github_owner: "fac",
+  tag_prefix: "harness-deploy",
+}
+OptionParser.new do |opts|
+  opts.banner = "Usage: check-recent-deploy [options]"
+
+  opts.on("--allowed-rollback-count NUMBER", "Number of deployments that can be rolled back, defaults to 3") do |v|
+    options[:allowed_rollback_count] = v.to_i
+  end
+
+  opts.on("-b", "--build-no REVISION", "Build number/deployment revision") do |v|
+    options[:build_no] = v
+  end
+
+  opts.on("-e", "--environment NAME", "Environment name") do |v|
+    options[:environment] = v
+  end
+
+  opts.on("--github-owner NAME", "GitHub organisation/owner name, defaults to 'fac'") do |v|
+    options[:github_owner] = v
+  end
+
+  opts.on("-r", "--repository NAME", "GitHub repository name") do |v|
+    options[:repo] = v
+  end
+
+  opts.on("--tag-prefix PREFIX", "Git tag prefix, defaults to 'harness-deploy'") do |v|
+    options[:tag_prefix] = v
+  end
+end.parse!
+
+client = FaHarnessTools::GithubClient.new(
+  oauth_token: ENV.fetch("GITHUB_OAUTH_TOKEN"),
+  owner: options.fetch(:github_owner),
+  repo: options.fetch(:repo),
+)
+context = FaHarnessTools::HarnessContext.new(
+  client: client,
+  environment: options.fetch(:environment),
+  build_no: options.fetch(:build_no),
+)
+
+result = FaHarnessTools::CheckRecentDeploy.new(
+  client: client,
+  context: context,
+  tag_prefix: options.fetch(:tag_prefix),
+  allowed_rollback_count: options.fetch(:allowed_rollback_count),
+).verify?
+
+if result.first
+  puts result.last
+  exit 0
+else
+  $stderr.puts result.last
+  exit 1
+end

data/exe/check-schedule

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby
+
+require "fa-harness-tools"
+require "optparse"
+
+options = {}
+OptionParser.new do |opts|
+  opts.banner = "Usage: check-schedule [options]"
+end.parse!
+
+result = FaHarnessTools::CheckSchedule.new.verify?
+
+if result.first
+  puts result.last
+  exit 0
+else
+  $stderr.puts result.last
+  exit 1
+end

data/exe/create-deployment-tag

@@ -0,0 +1,69 @@
+#!/usr/bin/env ruby
+
+require "fa-harness-tools"
+require "optparse"
+require "time"
+
+options = {
+  github_owner: "fac",
+  tag_prefix: "harness-deploy",
+  tagger_email: "harness@example.com",
+  tagger_name: "Harness",
+}
+OptionParser.new do |opts|
+  opts.banner = "Usage: create-deployment-tag [options]"
+
+  opts.on("-b", "--build-no REVISION", "Build number/deployment revision") do |v|
+    options[:build_no] = v
+  end
+
+  opts.on("-e", "--environment NAME", "Environment name") do |v|
+    options[:environment] = v
+  end
+
+  opts.on("--github-owner NAME", "GitHub organisation/owner name, defaults to 'fac'") do |v|
+    options[:github_owner] = v
+  end
+
+  opts.on("-r", "--repository NAME", "GitHub repository name") do |v|
+    options[:repo] = v
+  end
+
+  opts.on("--tag-prefix PREFIX", "Git tag prefix, defaults to 'harness-deploy'") do |v|
+    options[:tag_prefix] = v
+  end
+
+  opts.on("--tagger-email EMAIL", "Author email address for the Git tag, defaults to 'harness@example.com'") do |v|
+    options[:tagger_email] = v
+  end
+
+  opts.on("--tagger-name NAME", "Author name for the Git tag, defaults to 'Harness'") do |v|
+    options[:tagger_name] = v
+  end
+end.parse!
+
+client = FaHarnessTools::GithubClient.new(
+  oauth_token: ENV.fetch("GITHUB_OAUTH_TOKEN"),
+  owner: options.fetch(:github_owner),
+  repo: options.fetch(:repo),
+)
+context = FaHarnessTools::HarnessContext.new(
+  client: client,
+  environment: options.fetch(:environment),
+  build_no: options.fetch(:build_no),
+)
+
+tag_time = Time.now.utc
+timestamp = tag_time.strftime("%Y-%m-%dT%H-%M-%SZ")
+
+tag = client.create_tag(
+  "#{options.fetch(:tag_prefix)}-#{context.environment}-#{timestamp}",
+  "Harness deployment at #{timestamp}",
+  context.new_commit_sha,
+  "commit",
+  options.fetch(:tagger_name),
+  options.fetch(:tagger_email),
+  tag_time.strftime("%Y-%m-%dT%H:%M:%SZ"),
+)
+
+puts "Created tag #{tag[:tag]}"

data/fa-harness-tools.gemspec

@@ -0,0 +1,37 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "fa-harness-tools/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "fa-harness-tools"
+  spec.version       = FaHarnessTools::VERSION
+  spec.authors       = ["FreeAgent"]
+  spec.email         = ["opensource@freeagent.com"]
+
+  spec.summary       = %q{Tools including preflight checks for Harness.io}
+  spec.description   = %q{FreeAgent-specific pre-flight checks and tools that are designed to work in Harness.io}
+  spec.homepage      = "https://github.com/fac/fa-harness-tools"
+  spec.license       = "Apache-2.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "https://github.com/fac/fa-harness-tools/releases"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "octokit", "~> 4.0"
+  spec.add_runtime_dependency "tzinfo", "~> 2.0"
+  spec.add_runtime_dependency "tzinfo-data", "~> 1.0"
+
+  spec.add_development_dependency "bundler", "~> 1.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.8"
+  spec.add_development_dependency "timecop", "~> 0.9"
+end

data/lib/fa-harness-tools.rb

@@ -0,0 +1,11 @@
+require "fa-harness-tools/check_branch_protection"
+require "fa-harness-tools/check_forward_deploy"
+require "fa-harness-tools/check_recent_deploy"
+require "fa-harness-tools/check_schedule"
+require "fa-harness-tools/github_client"
+require "fa-harness-tools/harness_context"
+require "fa-harness-tools/version"
+
+module FaHarnessTools
+  LookupError = Class.new(StandardError)
+end

data/lib/fa-harness-tools/check_branch_protection.rb

@@ -0,0 +1,19 @@
+module FaHarnessTools
+  # Check if the sha being deployed belongs to the given branch.
+  class CheckBranchProtection
+    def initialize(client:, context:, branch:)
+      @client = client
+      @context = context
+      @branch = branch
+    end
+
+    def verify?
+      new_sha = @context.new_commit_sha
+      if @client.branch_contains?(@branch, new_sha)
+        [true, "#{@branch} contains #{new_sha}"]
+      else
+        [false, "#{@branch} does not contain #{new_sha}"]
+      end
+    end
+  end
+end

data/lib/fa-harness-tools/check_forward_deploy.rb

@@ -0,0 +1,38 @@
+module FaHarnessTools
+  # Checks if the revision to deploy is ahead of the deployed revision,  a
+  # forward deploy. The currently deployed revision is an ancestor of the
+  # revision to deploy.
+  #
+  # In order to work out what is currently deployed it checks for tags with
+  # the configured tag_prefix, the newest of those is considered the current
+  # version.
+  # If there are none of those tags at all it will allow, to avoid creating an
+  # un-passable check!
+  class CheckForwardDeploy
+    def initialize(client:, context:, tag_prefix:)
+      @client = client
+      @context = context
+      @tag_prefix = tag_prefix
+    end
+
+    def verify?
+      current_tag = @client.last_deploy_tag(
+        prefix: @tag_prefix, environment: @context.environment)
+
+      if current_tag.nil?
+        # If no previous deploys we need to let it deploy otherwise it will
+        # never get past this check!
+        return true, "first deploy"
+      end
+
+      current_deployed_rev = current_tag[:commit][:sha]
+      rev = @context.new_commit_sha
+
+      if @client.is_ancestor_of?(current_deployed_rev, rev)
+        [true, "forward deploy, #{rev} is ahead of #{current_deployed_rev}"]
+      else
+        [false, "not a forward deploy, #{rev} is behind #{current_deployed_rev}"]
+      end
+    end
+  end
+end

data/lib/fa-harness-tools/check_recent_deploy.rb

@@ -0,0 +1,55 @@
+module FaHarnessTools
+  # CheckRecentDeploy only allows deployer to deploy commits with `deploy_tag_prefix` ahead of (and include) Nth most recent commit
+  # with the give tag.
+  #
+  # For example if the commit history is like
+  #
+  # SHA 1
+  # SHA 2 - tag: production-deploy-1
+  # SHA 3
+  # SHA 4 - tag: production-deploy-2
+  # SHA 5
+  # SHA 6 - tag: production-deploy-3
+  # SHA 7
+  # SHA 8 - tag: production-deploy-4
+  #
+  # If the age deploy check is set to
+  #   tag_prefix: "production-deploy"
+  #   allowed_rollback_count: 2
+  #
+  # Then SHA 1 - 4 would be allowed, however SHA 5 - 8 would get denied
+  #
+  # Notes if the tag `production-deploy-` doesn't exist in Git history, the check returns allow
+  #
+  class CheckRecentDeploy
+    def initialize(client:, context:, tag_prefix:, allowed_rollback_count:)
+      @client = client
+      @context = context
+      @tag_prefix = tag_prefix
+      @allowed_rollback_count = allowed_rollback_count
+    end
+
+    def verify?
+      tags = @client.
+        all_deploy_tags(prefix: @tag_prefix, environment: @context.environment).
+        sort_by { |tag| tag[:name] }
+
+      latest_allowed_tag = tags.last(@allowed_rollback_count).first
+
+      if latest_allowed_tag.nil?
+        # If no previous deploys we need to let it deploy otherwise it will
+        # never get past this check!
+        return true, "first deploy"
+      end
+
+      latest_allowed_rev = latest_allowed_tag[:commit][:sha]
+      rev = @context.new_commit_sha
+
+      if @client.is_ancestor_of?(latest_allowed_rev, rev)
+        [true, "#{rev} is ahead of no.#{@allowed_rollback_count} most recent commit with #{@tag_prefix.inspect} tag"]
+      else
+        [false, "#{rev} is prior to no.#{@allowed_rollback_count} most recent commit with #{@tag_prefix.inspect} tag"]
+      end
+    end
+  end
+end

data/lib/fa-harness-tools/check_schedule.rb

@@ -0,0 +1,31 @@
+require "time"
+require "tzinfo"
+
+module FaHarnessTools
+  # Check against the time of day so you can restrict deploying to sensible
+  # hours. Uses local London time by default.
+  #
+  # Restricts to Mon-Thu from 9am to 4pm, Fri from 9am to 12pm.
+  class CheckSchedule
+    def initialize(timezone: "Europe/London")
+      tz = TZInfo::Timezone.get(timezone)
+      @now = tz.to_local(Time.now.utc)
+    end
+
+    def verify?
+      permitted = false
+      case @now.wday
+      when 1..4
+        permitted = true if @now.hour >= 9 && @now.hour < 16
+      when 5
+        permitted = true if @now.hour >= 9 && @now.hour < 12
+      end
+
+      if permitted
+        [true, "scheduled deploy time"]
+      else
+        [false, "outside deployment schedule"]
+      end
+    end
+  end
+end

data/lib/fa-harness-tools/github_client.rb

@@ -0,0 +1,94 @@
+require "octokit"
+
+# Wraps the GitHub operations we're using
+module FaHarnessTools
+  class GithubClient
+    attr_reader :owner, :repo
+
+    def initialize(oauth_token:, owner:, repo:)
+      @octokit = Octokit::Client.new(access_token: oauth_token)
+      @owner = owner
+      @repo = repo
+    end
+
+    def owner_repo
+      "#{owner}/#{repo}"
+    end
+
+    # Return all tags starting "harness-deploy-ENV-"
+    #
+    # Used to find deployments in an environment. The commit SHA of the tag is
+    # in [:commit][:sha] in the returned hash.
+    #
+    # @return [Array[Hash]] Array of tag data hash, or [] if none
+    def all_deploy_tags(prefix:, environment:)
+      @octokit.auto_paginate = true
+      @octokit.tags(owner_repo).find_all do |tag|
+        tag[:name].start_with?("#{prefix}-#{environment}-")
+      end
+    ensure
+      @octokit.auto_paginate = false
+    end
+
+    # Return the last (when sorted) tag starting "harness-deploy-ENV-"
+    #
+    # Used to find the most recent deployment in an environment. The commit SHA
+    # of the tag is in [:commit][:sha] in the returned hash.
+    #
+    # @return [Hash] Tag data hash, or nil if none
+    def last_deploy_tag(prefix:, environment:)
+      last_tag = all_deploy_tags(prefix: prefix, environment: environment).
+        sort_by { |tag| tag[:name] }.last
+      last_tag ? last_tag : nil
+    end
+
+    # Return a full commit SHA from a short SHA
+    #
+    # @return [String] Full commit SHA
+    # @raise [LookupError] If short SHA cannot be found
+    def get_commit_sha(short_sha)
+      commit = @octokit.commit(owner_repo, short_sha)
+      raise LookupError, "Unable to find commit #{short_sha} in Git repo" unless commit
+      commit[:sha]
+    end
+
+    # Checks if <ancestor> is an ancestor of <commit>
+    #
+    # i.e. commit and ancestor are directly related
+    #
+    # @return [Bool] True is <ancestor> is ancestor of <commit>
+    def is_ancestor_of?(ancestor, commit)
+      !!find_commit(commit) { |c| c[:sha] == ancestor }
+    end
+
+    # Checks if <commit> is on branch <branch>
+    #
+    # @return [Bool] True is <commit> is on <branch>
+    def branch_contains?(branch, commit)
+      !!find_commit(branch) { |c| c[:sha] == commit }
+    end
+
+    # Creates a Git tag
+    #
+    # Arguments match Octokit::Client::Objects#create_tag, minus first repo argument
+    # (http://octokit.github.io/octokit.rb/Octokit/Client/Objects.html#create_tag-instance_method)
+    def create_tag(tag, message, commit_sha, *args)
+      @octokit.create_ref(owner_repo, "tags/#{tag}", commit_sha)
+      @octokit.create_tag(owner_repo, tag, message, commit_sha, *args)
+    end
+
+    private
+
+    # Paginate over commits from a given sha/branch, and exit early if the
+    # supplied block matches
+    def find_commit(sha_or_branch, &block)
+      result = @octokit.commits(owner_repo, sha_or_branch).find(&block)
+      response = @octokit.last_response
+      until result || !response.rels[:next]
+        response = response.rels[:next].get
+        result = response.data.find(&block)
+      end
+      result
+    end
+  end
+end

data/lib/fa-harness-tools/harness_context.rb

@@ -0,0 +1,15 @@
+module FaHarnessTools
+  class HarnessContext
+    attr_reader :environment
+
+    def initialize(client:, environment:, build_no:)
+      @client = client
+      @environment = environment
+      @build_no = build_no
+    end
+
+    def new_commit_sha
+      @client.get_commit_sha(@build_no)
+    end
+  end
+end

data/lib/fa-harness-tools/version.rb

@@ -0,0 +1,3 @@
+module FaHarnessTools
+  VERSION = "1.0.4"
+end

metadata

@@ -0,0 +1,177 @@
+--- !ruby/object:Gem::Specification
+name: fa-harness-tools
+version: !ruby/object:Gem::Version
+  version: 1.0.4
+platform: ruby
+authors:
+- FreeAgent
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-11-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: octokit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: tzinfo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: tzinfo-data
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: FreeAgent-specific pre-flight checks and tools that are designed to work
+  in Harness.io
+email:
+- opensource@freeagent.com
+executables:
+- check-branch-protection
+- check-forward-deploy
+- check-recent-deploy
+- check-schedule
+- create-deployment-tag
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/ruby.yml"
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/check-branch-protection
+- exe/check-forward-deploy
+- exe/check-recent-deploy
+- exe/check-schedule
+- exe/create-deployment-tag
+- fa-harness-tools.gemspec
+- lib/fa-harness-tools.rb
+- lib/fa-harness-tools/check_branch_protection.rb
+- lib/fa-harness-tools/check_forward_deploy.rb
+- lib/fa-harness-tools/check_recent_deploy.rb
+- lib/fa-harness-tools/check_schedule.rb
+- lib/fa-harness-tools/github_client.rb
+- lib/fa-harness-tools/harness_context.rb
+- lib/fa-harness-tools/version.rb
+homepage: https://github.com/fac/fa-harness-tools
+licenses:
+- Apache-2.0
+metadata:
+  homepage_uri: https://github.com/fac/fa-harness-tools
+  source_code_uri: https://github.com/fac/fa-harness-tools
+  changelog_uri: https://github.com/fac/fa-harness-tools/releases
+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.7.6
+signing_key: 
+specification_version: 4
+summary: Tools including preflight checks for Harness.io
+test_files: []