fa-harness-tools 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 421353286e74cdc70badf595a611fc8d9a34a5f14e4341cacac88bbba11cee19
-  data.tar.gz: f80a236d16ea035736191b65c2138abec2cff6c126d36b930b3866e01d50489d
+  metadata.gz: 51253c635049f814f42fcac831fd937ed713254a29547cf5915fc2861848a52e
+  data.tar.gz: ed786f440ef207a1f2d6b4c920d82f673c1726c81571f4d0cec692f02a2c42a4
 SHA512:
-  metadata.gz: d610913dbd0979c1d6d5a19a04fe68b511042e333fbd4a616919855fb1d34dca130ea10e1e6a5d58d0579ad86fd796f9e2983a19ae222ddd2dea9b1015bbd229
-  data.tar.gz: 0fa44445386572aa266ef138f1bcc1bda3b84ea8b0fe6f98cfd86f17d58c0e5f045650c9b19bbc7309018f1cb9e0237f3e07f34f01e75b0110009d20a26035c3
+  metadata.gz: 3cb5bc18ffb6355a629de71c8220f851e12a85814e59549f8cfd7b259d4425d4422f81e0d85dc2e80e05e9fa76c5d5b3dfb12fe161fc61a9b87550dbd61300af
+  data.tar.gz: 73877cc9224058d573a41b3ab1b34e67d0fe8bbf06c17a408b37f646d552d7b627fab219d2b042654297b9ccb9dae09fbc4f1d833a6fae3e798b3603970fc320

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    fa-harness-tools (1.1.0)
+    fa-harness-tools (1.2.0)
+      fugit (~> 1.3)
       octokit (~> 4.0)
       pastel (~> 0.7)
       tzinfo (~> 2.0)
@@ -15,8 +16,13 @@ GEM
     concurrent-ruby (1.1.6)
     diff-lcs (1.3)
     equatable (0.6.1)
+    et-orbi (1.2.4)
+      tzinfo
     faraday (1.0.1)
       multipart-post (>= 1.2, < 3)
+    fugit (1.3.5)
+      et-orbi (~> 1.1, >= 1.1.8)
+      raabro (~> 1.1)
     multipart-post (2.1.1)
     octokit (4.18.0)
       faraday (>= 0.9)
@@ -25,6 +31,7 @@ GEM
       equatable (~> 0.6)
       tty-color (~> 0.5)
     public_suffix (4.0.5)
+    raabro (1.3.1)
     rake (13.0.1)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
@@ -60,4 +67,4 @@ DEPENDENCIES
   timecop (~> 0.9)
 
 BUNDLED WITH
-   1.16.4
+   1.17.2

data/exe/check-schedule

@@ -3,11 +3,32 @@
 require "fa-harness-tools"
 require "optparse"
 
-options = {}
+options = {
+  schedules: [],
+  timezone: "Europe/London",
+}
 OptionParser.new do |opts|
   opts.banner = "Usage: check-schedule [options]"
+
+  opts.on("--schedule CRON", "Schedule defines a window in which a deployment can take place. Accepts cron syntax, e.g. '* 9-15 * * mon-thu'") do |v|
+    options[:schedules] << v
+  end
+
+  opts.on("--timezone TIMEZONE", "Specify the timezone which the schedule will be checked in, e.g. 'Europe/London'") do |v|
+    options[:timezone] = v
+  end
 end.parse!
 
-result = FaHarnessTools::CheckSchedule.new.verify?
+def schedules(options)
+  if options[:schedules].length == 0
+    options[:schedules] = [
+      "* 9-15 * * mon-thu",
+      "* 9-11 * * fri",
+    ]
+  end
+  options[:schedules].map { |schedule| FaHarnessTools::Schedule.new(schedule: schedule.to_s) }
+end
+
+result = FaHarnessTools::CheckSchedule.new(timezone: options[:timezone], schedules: schedules(options)).verify?
 
 exit result ? 0 : 1

data/fa-harness-tools.gemspec

@@ -30,6 +30,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "pastel", "~> 0.7"
   spec.add_runtime_dependency "tzinfo", "~> 2.0"
   spec.add_runtime_dependency "tzinfo-data", "~> 1.0"
+  spec.add_runtime_dependency "fugit", "~> 1.3"
 
   spec.add_development_dependency "bundler", "~> 1.0"
   spec.add_development_dependency "rake", "~> 13.0"

data/lib/fa-harness-tools.rb

@@ -3,10 +3,12 @@ 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/schedule"
 require "fa-harness-tools/github_client"
 require "fa-harness-tools/harness_context"
 require "fa-harness-tools/version"
 
 module FaHarnessTools
   LookupError = Class.new(StandardError)
+  InvalidScheduleError = Class.new(StandardError)
 end

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

@@ -3,14 +3,13 @@ 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.
+  # hours.
   class CheckSchedule
-    def initialize(timezone: "Europe/London")
+    def initialize(timezone:, schedules:)
       tz = TZInfo::Timezone.get(timezone)
       @timezone = timezone
       @now = tz.to_local(Time.now.utc)
+      @schedules = schedules
       @logger = CheckLogger.new(
         name: "Check deployment schedule",
         description: "Only allow deployments within certain times of the day",
@@ -22,19 +21,16 @@ module FaHarnessTools
       @logger.info("operating in the #{@timezone} timezone")
       @logger.info("local time is #{@now}")
 
-      permitted = false
-      case @now.wday
-      when 1..4
-        @logger.info("deployments are allowed between 9am to 4pm today (Mon-Thu)")
-        permitted = true if @now.hour >= 9 && @now.hour < 16
-      when 5
-        @logger.info("deployments are allowed between 9am to 12pm today (Fri)")
-        permitted = true if @now.hour >= 9 && @now.hour < 12
+      permitted = @schedules.any? do |schedule|
+        can_run = schedule.can_run?(time: @now)
+        @logger.info("deployments are allowed due to the following schedule: #{schedule.to_s}") if can_run
+        can_run
       end
 
       if permitted
         @logger.pass "inside the deployment schedule"
       else
+        @logger.info "failed to match any schedule #{@schedules.map(&:to_s).join(", ")}"
         @logger.fail "outside the deployment schedule"
       end
     end

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

@@ -0,0 +1,22 @@
+require 'fugit'
+
+module FaHarnessTools
+  # Creates a schedule which can be used to check if a change
+  # should be deployed.
+  class Schedule
+    def initialize(schedule:)
+      @schedule = schedule
+      @cron_schedule = Fugit.parse(schedule)
+      raise InvalidScheduleError, "'#{schedule}' can not be parsed" unless @cron_schedule
+    end
+
+    def can_run?(time:)
+      return false unless @cron_schedule.day_match?(time)
+      return @cron_schedule.hour_match?(time)
+    end
+
+    def to_s
+      return @schedule
+    end
+  end
+end

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

@@ -1,3 +1,3 @@
 module FaHarnessTools
-  VERSION = "1.1.0"
+  VERSION = "1.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fa-harness-tools
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - FreeAgent
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-05-25 00:00:00.000000000 Z
+date: 2020-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: octokit
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: fugit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -165,6 +179,7 @@ files:
 - 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/schedule.rb
 - lib/fa-harness-tools/version.rb
 homepage: https://github.com/fac/fa-harness-tools
 licenses: