vidar 1.5.4 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c00bab992d33cc5485394ff4942569a73b4b0a8ae6aba4a64d96db922edfa46e
-  data.tar.gz: bc83c5d33cffae2c695d40e61378b5fb2326a789016a73b80be6df0c10c3177c
+  metadata.gz: eb2df292256761c82b4c0faab70db10cb3fcf9f6b28a3777ba5843cb9949deea
+  data.tar.gz: eed9221ba5e8418ecc518b7c2168a469235bc383949c32d09e23f0ff3086a5b1
 SHA512:
-  metadata.gz: b3afdc47337321ea2bb3af105de27a5be2bab972e2e81f8c63c47d6deb9c8becbae9e90eba764a905c1262f54e5842269242db011ba5d6c643686627f377ff5c
-  data.tar.gz: d81b57bc6be8eccb2d370424167655ace1a74fff390bdd391d2ff1ce0527623f001c99b66f266b1319fc109de15e092cb4edd93886fde4c0a15757e37a80442d
+  metadata.gz: 6d949b5d18bafd71eed2722831c68b5bae941cf1e7fb62f8f5cb8c7b3a2e8c99ed54893a2982eecaf61857b984f772f5b40a1682504d538f1d97dafa9ac06b47
+  data.tar.gz: 1ed526fadb5d7780c1fdeaf6847793a7265329d1a29944a7a430245a0adcbd32efc33e15ef24f6f336fa8eec7cb1106bdea9d5e2e827a756788a3a7e2c518981

data/.bundler-version

@@ -1 +1 @@
-2.3.25
+2.4.4

data/.dependabot/config.yml

@@ -14,3 +14,6 @@ update_configs:
       - match:
           dependency_type: "all"
           update_type: "security:patch"
+    labels:
+      - "automerge"
+      - "dependencies"

data/.github/workflows/auto-merge-dependencies.yml

@@ -0,0 +1,24 @@
+name: automerge-dependencies
+on:
+  pull_request_review:
+    types:
+      - submitted
+  check_suite:
+    types:
+      - completed
+  label:
+    types:
+      - created
+  status: {}
+jobs:
+  automerge:
+    runs-on: ubuntu-latest
+    steps:
+      - name: automerge-dependencies
+        uses: pascalgn/automerge-action@v0.14.3
+        env:
+          GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
+          MERGE_METHOD: squash
+          MERGE_DELETE_BRANCH: true
+          MERGE_LABELS: dependencies
+          MERGE_REMOVE_LABELS: ""

data/.github/workflows/auto-merge.yml

@@ -6,13 +6,16 @@ on:
   check_suite:
     types:
       - completed
+  label:
+    types:
+      - created
   status: {}
 jobs:
   automerge:
     runs-on: ubuntu-latest
     steps:
       - name: automerge
-        uses: "pascalgn/automerge-action@v0.12.0"
+        uses: pascalgn/automerge-action@v0.14.3
         env:
           GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
           MERGE_METHOD: squash

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # CHANGELOG
 
+## 1.7.0 - 2023-01-23
+
+Add support for publishing Honeycomb markers on deployment.
+
+## 1.6.0 - 2022-12-07
+
+Allow more complex deployments. By passing extra options to the deployment command, we allow deployments where there are multiple containers per pod or where there is more than just deployments/cronjobs (like deamonsets or something similar).
+
 ## 1.5.3 - 2022-09-20
 
 - fix determining deploy hook status (issue introduced in 1.5.2)

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    vidar (1.5.4)
+    vidar (1.7.0)
       colorize
       faraday
       thor (~> 1.0)
@@ -18,20 +18,20 @@ GEM
     crack (0.4.5)
       rexml
     diff-lcs (1.5.0)
-    faraday (2.7.1)
+    faraday (2.7.4)
       faraday-net_http (>= 2.0, < 3.1)
       ruby2_keywords (>= 0.0.4)
     faraday-net_http (3.0.2)
     hashdiff (1.0.1)
-    json (2.6.2)
+    json (2.6.3)
     method_source (1.0.0)
     parallel (1.22.1)
-    parser (3.1.2.1)
+    parser (3.2.0.0)
       ast (~> 2.4.1)
-    pry (0.14.1)
+    pry (0.14.2)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    public_suffix (5.0.0)
+    public_suffix (5.0.1)
     rainbow (3.1.1)
     rake (13.0.6)
     regexp_parser (2.6.1)
@@ -42,33 +42,36 @@ GEM
       rspec-mocks (~> 3.12.0)
     rspec-core (3.12.0)
       rspec-support (~> 3.12.0)
-    rspec-expectations (3.12.0)
+    rspec-expectations (3.12.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
-    rspec-mocks (3.12.0)
+    rspec-mocks (3.12.3)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
     rspec-support (3.12.0)
-    rubocop (1.39.0)
+    rubocop (1.43.0)
       json (~> 2.3)
       parallel (~> 1.10)
-      parser (>= 3.1.2.1)
+      parser (>= 3.2.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.23.0, < 2.0)
+      rubocop-ast (>= 1.24.1, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.23.0)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.24.1)
       parser (>= 3.1.1.0)
+    rubocop-capybara (2.17.0)
+      rubocop (~> 1.41)
     rubocop-rake (0.6.0)
       rubocop (~> 1.0)
-    rubocop-rspec (2.15.0)
+    rubocop-rspec (2.18.0)
       rubocop (~> 1.33)
+      rubocop-capybara
     ruby-progressbar (1.11.0)
     ruby2_keywords (0.0.5)
     thor (1.2.1)
-    unicode-display_width (2.3.0)
+    unicode-display_width (2.4.2)
     webmock (3.18.1)
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
@@ -90,4 +93,4 @@ DEPENDENCIES
   webmock
 
 BUNDLED WITH
-   2.3.22
+   2.3.26

data/README.md

@@ -71,6 +71,8 @@ image: gcr.io/[GCP-PROJECT-ID]/[APP-NAME]
 namespace: borrower
 # github name used to build deployment notification content
 github: RenoFi/vidar
+# The key to use for creating honeycomb markers, defaults to HONEYCOMB_API_KEY env var
+honeycomb_api_key: secret
 # deployments config per kubectl context, required for `monitor_deploy_status` command
 deployments:
   gke_project_us-east4_staging:
@@ -88,6 +90,8 @@ deployments:
     sentry_webhook_url: https://sentry.io/api/hooks/release/builtin/123/asdf/
     # Slack webhook url used to send deploy notifications, optional
     slack_webhook_url: https://hooks.slack.com/services/ASCKNZ0vug2R3Ydo/ASCKNZ0vug2R3Ydo/ASCKNZ0vug2R3Ydo
+    # Name of the Honeycomb dataset to create a deployment marker in
+    honeycomb_dataset: staging
 # docker-compose file, optional, default value: docker-compose.ci.yml
 compose_file: docker-compose.ci.yml
 # default_branch, optional, default value: main or master (auto-detected from local branches)

data/lib/vidar/cli.rb

@@ -66,6 +66,9 @@ module Vidar
     desc "deploy", "Perform k8s deployment with deploy hook"
     method_option :revision, required: false
     method_option :kubectl_context, required: false
+    method_option :destination, required: false, default: "deployments,cronjobs"
+    method_option :container, required: false, default: "*"
+    method_option :all, required: false, type: :boolean, default: true
     def deploy
       revision = options[:revision] || Config.get!(:revision)
       kubectl_context = options[:kubectl_context] || Config.get!(:kubectl_context)
@@ -75,6 +78,7 @@ module Vidar
       template_name, error, status = Open3.capture3 "kubectl get cronjob deploy-hook-template -n #{Config.get!(:namespace)} -o name --ignore-not-found=true"
 
       slack_notification = SlackNotification.get
+      honeycomb_notification = HoneycombNotification.get
 
       if status.success?
         if template_name.to_s.empty?
@@ -93,17 +97,22 @@ module Vidar
             Run.kubectl "describe job deploy-hook"
             Log.error "Error running deploy hook template"
             slack_notification.failure if slack_notification.configured?
+            honeycomb_notification.failure
             exit(1)
           end
         end
       else
         Log.info "Error getting deploy hook template: #{error}"
         slack_notification.failure if slack_notification.configured?
+        honeycomb_notification.failure
         exit(1)
       end
 
-      Log.info "Set kubectl image..."
-      Run.kubectl "set image deployments,cronjobs *=#{Config.get!(:image)}:#{revision} --all"
+      destination = options[:destination]
+      container = options[:container]
+      all = options[:all]
+      Log.info "Set kubectl image for #{all ? 'all ' : ''}#{destination} container=#{container}..."
+      Run.kubectl "set image #{destination} #{container}=#{Config.get!(:image)}:#{revision} #{all ? '--all' : ''}"
     end
 
     desc "release", "Build and publish docker images"
@@ -121,6 +130,7 @@ module Vidar
       Log.info "Checking if all containers in #{Config.get!(:namespace)} namespace(s) are ready..."
 
       slack_notification = SlackNotification.get
+      honeycomb_notification = HoneycombNotification.get
 
       deploy_status = Vidar::DeployStatus.new(namespace: Config.get!(:namespace))
 
@@ -129,10 +139,12 @@ module Vidar
       if deploy_status.success?
         Log.info "OK: All containers are ready"
         slack_notification.success if slack_notification.configured?
+        honeycomb_notification.success
         invoke :notify_sentry
       else
         Log.error "ERROR: Some of containers are errored or not ready"
         slack_notification.failure if slack_notification.configured?
+        honeycomb_notification.failure
         exit(1)
       end
     end
@@ -189,6 +201,11 @@ module Vidar
       sentry_notification.call if sentry_notification.configured?
     end
 
+    desc "notify_honeycomb", "Send test honeycomb notification"
+    def notify_honeycomb
+      HoneycombNotification.get.success
+    end
+
     method_option :message, required: true
     desc "notify_slack", "Send custom slack notification"
     def notify_slack

data/lib/vidar/config.rb

@@ -14,6 +14,7 @@ module Vidar
       console_command:    -> { "bin/console" },
       base_stage_name:    -> { "base" },
       release_stage_name: -> { "release" },
+      honeycomb_api_key: -> { ENV['HONEYCOMB_API_KEY'] },
     }.freeze
 
     class << self

data/lib/vidar/deploy_config.rb

@@ -6,7 +6,7 @@ module Vidar
 
     attr_reader :name, :url,
       :default_color, :success_color, :failure_color,
-      :slack_webhook_url, :sentry_webhook_url
+      :slack_webhook_url, :sentry_webhook_url, :honeycomb_dataset
 
     def initialize(options)
       @name = options.fetch(:name)
@@ -18,6 +18,7 @@ module Vidar
 
       @slack_webhook_url = options[:slack_webhook_url]
       @sentry_webhook_url = options[:sentry_webhook_url]
+      @honeycomb_dataset = options[:honeycomb_dataset]
     end
   end
 end

data/lib/vidar/honeycomb_notification.rb

@@ -0,0 +1,87 @@
+module Vidar
+  class HoneycombNotification
+    def self.get
+      new(
+        github:        Config.get!(:github),
+        revision:      Config.get!(:revision),
+        revision_name: Config.get!(:revision_name),
+        build_url:     Config.build_url,
+        deploy_config: Config.deploy_config,
+        api_key: Config.get(:honeycomb_api_key),
+      )
+    end
+
+    def initialize(github:, revision:, revision_name:, deploy_config:, build_url: nil, api_key: nil, connection: Faraday.new)
+      @github = github
+      @revision = revision
+      @revision_name = revision_name
+      @build_url = build_url
+      @api_key = api_key
+      @dataset = deploy_config.honeycomb_dataset
+      @connection = connection
+      @start_time = Time.now.utc
+      @end_time = nil
+      @success = false
+    end
+
+    def configured?
+      !dataset.nil? && !api_key.nil?
+    end
+
+    def success
+      @end_time = Time.now.utc
+      @success = true
+
+      call
+    end
+
+    def failure
+      @end_time = Time.now.utc
+      @success = false
+
+      call
+    end
+
+    private
+
+    attr_reader :connection,
+      :github,
+      :revision,
+      :revision_name,
+      :dataset,
+      :build_url,
+      :api_key,
+      :start_time,
+      :end_time
+
+    def success?
+      @success
+    end
+
+    def call
+      return false unless configured?
+
+      response = connection.post do |req|
+        req.url "https://api.honeycomb.io/1/markers/#{dataset}"
+        req.headers['Content-Type'] = 'application/json'
+        req.headers['X-Honeycomb-Team'] = api_key.to_s
+        req.body = data.to_json
+      end
+
+      return true if response.status == 201
+
+      warn "Honeycomb marker not created: status: #{response.status} response: #{response.body}"
+      false
+    end
+
+    def data
+      {
+        message: "#{success? ? 'Successful' : 'Failed'} deploy of #{github} revision #{revision} - #{revision_name}",
+        type: success? ? "deploy" : "failed_deploy",
+        start_time: start_time.to_i,
+        end_time: end_time.to_i,
+        url: build_url,
+      }
+    end
+  end
+end

data/lib/vidar/version.rb

@@ -1,3 +1,3 @@
 module Vidar
-  VERSION = '1.5.4'.freeze
+  VERSION = '1.7.0'.freeze
 end

data/lib/vidar.rb

@@ -10,6 +10,7 @@ require 'thor'
 
 require 'vidar/version'
 require 'vidar/config'
+require 'vidar/honeycomb_notification'
 require 'vidar/interpolation'
 require 'vidar/log'
 require 'vidar/run'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vidar
 version: !ruby/object:Gem::Version
-  version: 1.5.4
+  version: 1.7.0
 platform: ruby
 authors:
 - Krzysztof Knapik
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-11-22 00:00:00.000000000 Z
+date: 2023-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -195,6 +195,7 @@ files:
 - ".github/ISSUE_TEMPLATE/story.md"
 - ".github/PULL_REQUEST_TEMPLATE.md"
 - ".github/workflows/auto-approve.yml"
+- ".github/workflows/auto-merge-dependencies.yml"
 - ".github/workflows/auto-merge.yml"
 - ".github/workflows/ci.yml"
 - ".gitignore"
@@ -211,6 +212,7 @@ files:
 - lib/vidar/config.rb
 - lib/vidar/deploy_config.rb
 - lib/vidar/deploy_status.rb
+- lib/vidar/honeycomb_notification.rb
 - lib/vidar/interpolation.rb
 - lib/vidar/k8s/container.rb
 - lib/vidar/k8s/pod_set.rb
@@ -243,7 +245,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.4
 signing_key:
 specification_version: 4
 summary: K8s deployment tools based on thor