is_it_done_yet 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: acd12c54ad56816b78a4dce97b4959ca75f13392
-  data.tar.gz: 61d989bd6096d96b479d17b0823d360d8e374824
+SHA256:
+  metadata.gz: e0bc205289b71dd555c838316ae32015e128f6c8a5b745cda9e3ad4634532842
+  data.tar.gz: 8e0b4d53bd08b6bec60cca9d3db3898ce1f3f262d42128389dbe6666a5afe47d
 SHA512:
-  metadata.gz: 5e90bcdbe755b2430d43f1e3f9e4579e5ed262beeeb7eb0179aa0dad1531c6683a8ecbfc6cf8d56fdb286e2d451e176e7759cca98910a933147ccd41c82d8cb1
-  data.tar.gz: a13eb75011f38fe0492df830e8f7a7a5a3d0c8cbc9816c08c7bfb548acb35a79a847454c1bd7acc68a4a755bf3c5817799dce0225af87a78151d0e75dbc41ba3
+  metadata.gz: fecbd43c45b95141195fec9bfbe1f6c4136ac6d61f9f49be4309dce38d2d65473d72bafbb434c25d7f0fb38bb4542f58c03c480debdc22ea8cad7285fb240472
+  data.tar.gz: 4920233cd6b49f8d44cbcabcfdf77c583fef7b6813905417feedf9d05529a733e7f4672d88b4f28e6cdd0568b32c7b6523058029b8382f144a24a393e221a582

data/.gitignore

@@ -1,6 +1,5 @@
-/.bundle/
+git /.bundle/
 /.yardoc
-/Gemfile.lock
 /_yardoc/
 /coverage/
 /doc/
@@ -12,3 +11,5 @@
 .rspec_status
 *.gem
 .byebug_history
+
+.DS_Store

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+# 0.4.0
+
+Features:
+
+* Introduced `PUT /builds/:build_id/nodes/:node_id` which enables CI scripts that update node values for instance when rebuilding.
+
 # 0.3.0
 
 Features:

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in is_it_done_yet.gemspec

data/Gemfile.lock

@@ -0,0 +1,77 @@
+PATH
+  remote: .
+  specs:
+    is_it_done_yet (0.4.0)
+      concurrent-ruby
+      json
+      rack-contrib
+      rack-token_auth
+      sinatra (~> 2.0)
+      thin
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    byebug (10.0.2)
+    coderay (1.1.2)
+    concurrent-ruby (1.0.5)
+    daemons (1.2.6)
+    diff-lcs (1.3)
+    eventmachine (1.2.7)
+    json (2.1.0)
+    knapsack (1.16.0)
+      rake
+    method_source (0.9.0)
+    mustermann (1.0.2)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rack (2.0.5)
+    rack-contrib (2.0.1)
+      rack (~> 2.0)
+    rack-protection (2.0.1)
+      rack
+    rack-test (1.0.0)
+      rack (>= 1.0, < 3)
+    rack-token_auth (0.1.0)
+      rack
+    rake (12.3.1)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    sinatra (2.0.1)
+      mustermann (~> 1.0)
+      rack (~> 2.0)
+      rack-protection (= 2.0.1)
+      tilt (~> 2.0)
+    thin (1.7.2)
+      daemons (~> 1.0, >= 1.0.9)
+      eventmachine (~> 1.0, >= 1.0.4)
+      rack (>= 1, < 3)
+    tilt (2.0.8)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  byebug
+  is_it_done_yet!
+  knapsack
+  pry
+  rack-test
+  rake
+  rspec
+
+BUNDLED WITH
+   1.16.1

data/README.md

@@ -28,13 +28,16 @@ Or install it yourself as:
 
 This library includes a Rack application which you can instantiate by doing `IsItDoneYet.build_app`. In the [example Rack config](examples/config.ru) there's a setup with token-based auth middleware. Include a similar `config.ru` at the root of your application and run `bundle exec rackup` to start the web app locally. If you're running it on a cloud service, follow your service's guidelines on deploying Rack applications.
 
-The web app provides three endpoints:
-* `POST /builds/:build_id/nodes/:node_id`
+The web app provides five endpoints:
+* `POST /builds/:build_id/nodes/:node_id` to write value for node, failing to overwrite.
     - example request body: `{ "build_state" : "ok" }`
+* `PUT /builds/:build_id/nodes/:node_id` to write or overwrite value for node.
+    - example request body: `{ "build_state" : "building", "build_state_on_overwrite" : "rebuilding" }`
 * `GET /builds/:build_id`
     - example response body: `{ "build_states": { "51": "bad", "52": "ok" } }`
 * `GET /builds/:build_id/nodes/:node_id`
     - example response body: `{ "build_state": "ok" }`
+* `DELETE /builds/:build_id` to clear state for a build
 
 The app keeps the build states in memory. This means that values will be lost after a restart of the service. Further, load balancing across multiple instances will only work if routing to the individual instance is consistent for the same `:build_id` path parameter, but scaling beyond one app instance is not currently a known use case.
 

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 require 'knapsack'

data/bin/console

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'bundler/setup'
 require 'is_it_done_yet'

data/examples/ci-clear

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 # Script that clears build status of
 # travis nodes from synchronising service

data/examples/ci-deploy

@@ -1,4 +1,6 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
+
 main_node = ENV['CI_NODE_INDEX'] == '0'
 
 if main_node

data/examples/ci-post

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 # Script that posts build status of
 # travis nodes (from ARGV[0]) to synchronising service

data/examples/ci-put

@@ -0,0 +1,54 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# Script that puts build and rebuild status of
+# travis nodes (from ARGV[0] and ARGV[1]) to synchronising service
+require 'net/http'
+require 'uri'
+require 'json'
+
+env_ok = ENV['CI_NODE_INDEX'] &&
+         ENV['CI_NODE_TOTAL'] &&
+         ENV['IIDY_ENDPOINT'] &&
+         ENV['TRAVIS_BUILD_NUMBER'] &&
+         ENV['TRAVIS_JOB_NUMBER'] &&
+         ENV['IIDY_TOKEN']
+
+args_ok = ARGV[0]
+
+abort 'Bad env' unless env_ok
+abort 'Bad args' unless args_ok
+
+main_node = ENV['CI_NODE_INDEX'] == '0'
+auth_token = "Token token=\"#{ENV['IIDY_TOKEN']}\""
+
+if main_node
+  puts 'Main node!'
+else
+  # publish progress
+  build_id = "is_it_done_yet--#{ENV['TRAVIS_BUILD_NUMBER']}"
+  node_id = ENV['TRAVIS_JOB_NUMBER']
+
+  url = ENV['IIDY_ENDPOINT'] +
+        "/builds/#{build_id}/nodes/#{node_id}"
+
+  puts "URL: #{url}"
+
+  uri = URI(url)
+
+  request = Net::HTTP::Put.new(uri)
+  request['Authorization'] = auth_token
+  request.body = {
+    build_state: ARGV[0],
+    build_state_on_overwrite: ARGV[1]
+  }.compact.to_json
+  request.content_type = 'application/json'
+
+  response = Net::HTTP.start(
+    uri.hostname,
+    uri.port,
+    use_ssl: uri.scheme == 'https'
+  ) { |http| http.request(request) }
+
+  abort "Failed to put build status: #{response.code}" unless response.code == '204'
+end

data/examples/ci-sync

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 # Script that queries build status of
 # travis nodes from synchronising service
@@ -9,6 +10,8 @@ require 'uri'
 require 'json'
 
 OK_STATES = %w[OK GOOD].freeze
+BUILDING_STATE = 'BUILDING'.freeze
+REBUILDING_STATE = 'REBUILDING'.freeze
 SLEEP_TIME_SECONDS = 30
 
 env_ok = ENV['CI_NODE_INDEX'] &&
@@ -39,10 +42,11 @@ if main_node
   expected_size = ENV['CI_NODE_TOTAL'].to_i - 1
   attempts = 0
   success = false
+  rebuilding = false
 
   loop do
     attempts += 1
-    abort 'Failed to fetch results' if attempts > 10
+    abort 'Failed to fetch results' if attempts > 10 && !rebuilding
 
     puts "Attempt no. #{attempts} at fetching build states"
 
@@ -67,6 +71,14 @@ if main_node
       next
     end
 
+    rebuilding = build_states.any?{ |(_k, value)| REBUILDING_STATE == value.upcase  }
+    building = build_states.any?{ |(_k, value)| BUILDING_STATE == value.upcase  }
+    if rebuilding || building
+      puts 'Nodes are building or rebuilding'
+      sleep SLEEP_TIME_SECONDS
+      next
+    end
+
     success = build_states.all? { |(_k, value)| OK_STATES.include?(value.upcase) }
     break
   end

data/examples/config.ru

@@ -1,17 +1,22 @@
+# frozen_string_literal: true
+
 require 'bundler'
 require 'rack/contrib'
 require 'rack/token_auth'
 require 'is_it_done_yet'
 Bundler.require
 
+<<<<<<< HEAD
+=======
 # Shared secret authentication
+>>>>>>> bd110d4... EM: adding heartbeat to example setup
 use Rack::TokenAuth do |token, _options, _env|
   token == ENV['IIDY_TOKEN']
 end
 
 # Heartbeat endpoint
 map '/health_check' do
-  run ->(_env) { [200, { 'Content-Type' => 'text/plain' }, ['success']] }
+  run ->(_env) { [200, { "Content-Type" => "text/plain" }, ["success"]] }
 end
 
 run IsItDoneYet.build_app

data/is_it_done_yet.gemspec

@@ -1,6 +1,6 @@
-# coding: utf-8
+# frozen_string_literal: true
 
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'is_it_done_yet/version'
 
@@ -34,18 +34,19 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   # Always
-  spec.add_dependency 'concurrent-ruby', '~> 1'
-  spec.add_dependency 'sinatra', '~> 1.4'
-  spec.add_dependency 'thin', '~> 1.7'
-  spec.add_dependency 'rack-contrib', '~> 1.4'
-  spec.add_dependency 'rack-token_auth', '~> 0.1'
-  spec.add_dependency 'json', '~> 2'
+  spec.add_dependency 'concurrent-ruby'
+  spec.add_dependency 'json'
+  spec.add_dependency 'rack-contrib'
+  spec.add_dependency 'rack-token_auth'
+  spec.add_dependency 'sinatra', '~> 2.0'
+  spec.add_dependency 'thin'
 
   # Development
-  spec.add_development_dependency 'bundler', '~> 1.14'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'rack-test', '~> 0.6'
-  spec.add_development_dependency 'knapsack', '~> 1.13'
-  spec.add_development_dependency 'byebug', '~> 9'
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'byebug'
+  spec.add_development_dependency 'knapsack'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rack-test'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
 end

data/lib/is_it_done_yet.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'is_it_done_yet/version'
 require 'is_it_done_yet/web_app'
 require 'rack/contrib'

data/lib/is_it_done_yet/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module IsItDoneYet
-  VERSION = '0.3.0'.freeze
+  VERSION = '0.4.0'
 end

data/lib/is_it_done_yet/web_app.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'is_it_done_yet/version'
 require 'sinatra'
 require 'concurrent'
@@ -37,6 +39,12 @@ module IsItDoneYet
         settings.state[key] = [value, Time.now]
       end
 
+      def merge(key:, value_if_absent:, value_if_present:)
+        settings.state.merge_pair(key, [value_if_absent, Time.now]) do
+          [value_if_present, Time.now]
+        end
+      end
+
       def retrieve(key)
         build_state, _t = settings.state[key]
         build_state
@@ -104,5 +112,28 @@ module IsItDoneYet
 
       201
     end
+
+    # Example:
+    # PUT /builds/42/nodes/13?build_state=BUILDING&build_state_on_overwrite=REBUILDING
+    put '/builds/:build_id/nodes/:node_id' do
+      build_state, build_state_on_overwrite =
+        params.values_at('build_state', 'build_state_on_overwrite')
+      halt 400, NO_BUILD_STATE unless build_state
+
+      build_id, node_id = params.values_at('build_id', 'node_id')
+      k = key(build_id, node_id)
+
+      if build_state_on_overwrite
+        merge(
+          key: k,
+          value_if_absent: build_state,
+          value_if_present: build_state_on_overwrite
+        )
+      else
+        store(k, build_state)
+      end
+
+      204
+    end
   end
 end

metadata

@@ -1,183 +1,197 @@
 --- !ruby/object:Gem::Specification
 name: is_it_done_yet
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Erik Madsen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-25 00:00:00.000000000 Z
+date: 2018-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: sinatra
+  name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: thin
+  name: rack-contrib
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rack-contrib
+  name: rack-token_auth
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rack-token_auth
+  name: sinatra
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: json
+  name: thin
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: knapsack
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '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: '3.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rack-test
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: knapsack
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: byebug
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '9'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '9'
+        version: '0'
 description: In case you need to carry out build steps in one of the nodes of your
   CI project after the other nodes finish, e.g. deploying, then you need a way of
   ascertaining the status of the other nodes. This is what is_it_done_yet is for.
@@ -192,6 +206,7 @@ files:
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -200,6 +215,7 @@ files:
 - examples/ci-clear
 - examples/ci-deploy
 - examples/ci-post
+- examples/ci-put
 - examples/ci-sync
 - examples/config.ru
 - is_it_done_yet.gemspec
@@ -227,7 +243,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Tracks statuses of CI build nodes