config_skeleton 0.1.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 94091ff703a09d316f4bc62973a8995b1815bcc8a591c224fcffa147cba2cd9d
-  data.tar.gz: 47c9cb4ade0f69e2b5822e27800f70b0465cec2a3780aadfe70027e7d2088795
+  metadata.gz: 20798a914f83d1ab8531eb66259f202816e40ade371172102058536cf2fa3af7
+  data.tar.gz: 5f742b8f777496e322f845eccc9c641eb7bad0815c8853cd1eea26bbddd2080c
 SHA512:
-  metadata.gz: d1b5ed7d48c978e999a76441b8b43c0dee017dc12fc1e54dfb0c418f1d92d4d326457d3e06b5706a644966d607f8bc74ceb85d8d34fac58f72f51eff663b8cff
-  data.tar.gz: '08c0b0faf4151961eb18536408b576c43000b0409f189d613b9f9738c4ba54ebda2cc8a3925ba12699e7d3832aab651b09dad339ff362de9fff1fb37f8b54fe1'
+  metadata.gz: 9873af5655630b61a5833a58d6203836a78d4e11218802608fbcde86ada691e6e38ae2a52dd088037e00be1721aed145c6c057cd3c0175ad4279995d3da7d91e
+  data.tar.gz: a9e1d788d30246ee436a452076fd157d03864123b3b1eca420c26cb5d6c0684752a5028e4930f81195e2e47e6a8253f468564d525eb3bff8738bf61299d8658a

data/.github/workflows/ruby.yml

@@ -0,0 +1,48 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  push:
+    branches:
+      - master
+    tags:
+      - v*
+  pull_request:
+    branches:
+      - master
+  workflow_dispatch:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.6
+      - name: Install dependencies
+        run: bundle install
+      - name: Run specs
+        run: bundle exec rspec
+
+  publish:
+    if: contains(github.ref, 'refs/tags/v')
+    needs: build
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Release Gem
+        uses: CvX/publish-rubygems-action@master
+        env:
+          RUBYGEMS_API_KEY: ${{secrets.RUBYGEMS_API_KEY}}

data/.gitignore

@@ -4,5 +4,6 @@
 /.yardoc
 /coverage
 /.bundle
+/cfg.txt
 
 .rubocop-https---raw-githubusercontent-com-discourse-discourse-master--rubocop-yml

data/.rspec

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

data/README.md

@@ -41,7 +41,7 @@ conduct](CODE_OF_CONDUCT.md).
 Unless otherwise stated, everything in this repo is covered by the following
 copyright notice:
 
-    Copyright (C) 2018  Civilized Discourse Construction Kit, Inc.
+    Copyright (C) 2020 Civilized Discourse Construction Kit, Inc.
 
     This program is free software: you can redistribute it and/or modify it
     under the terms of the GNU General Public License version 3, as

data/config_skeleton.gemspec

@@ -1,21 +1,14 @@
-begin
-  require 'git-version-bump'
-rescue LoadError
-  nil
-end
-
 Gem::Specification.new do |s|
   s.name = "config_skeleton"
 
-  s.version = GVB.version rescue "0.0.0.1.NOGVB"
-  s.date    = GVB.date    rescue Time.now.strftime("%Y-%m-%d")
+  s.version = "0.4.1"
 
   s.platform = Gem::Platform::RUBY
 
   s.summary  = "Dynamically generate configs and reload servers"
 
-  s.authors  = ["Matt Palmer"]
-  s.email    = ["matt.palmer@discourse.org"]
+  s.authors  = ["Matt Palmer", "Discourse Team"]
+  s.email    = ["matt.palmer@discourse.org", "team@discourse.org"]
   s.homepage = "https://github.com/discourse/config_skeleton"
 
   s.files = `git ls-files -z`.split("\0").reject { |f| f =~ /^(G|spec|Rakefile)/ }
@@ -29,9 +22,11 @@ Gem::Specification.new do |s|
 
   s.add_development_dependency 'bundler'
   s.add_development_dependency 'github-release'
-  s.add_development_dependency 'git-version-bump'
   s.add_development_dependency 'rake', "~> 12.0"
   s.add_development_dependency 'redcarpet'
   s.add_development_dependency 'rubocop'
   s.add_development_dependency 'yard'
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'pry'
+  s.add_development_dependency 'pry-byebug'
 end

data/lib/config_skeleton.rb

@@ -5,6 +5,7 @@ require 'logger'
 require 'rb-inotify'
 require 'service_skeleton'
 require 'tempfile'
+require 'digest/md5'
 
 # Framework for creating config generation systems.
 #
@@ -23,7 +24,7 @@ require 'tempfile'
 #
 # 1. Implement service-specific config generation and reloading code, by
 #    overriding the private methods #config_file, #config_data, and #reload_server
-#    (and also potentially #config_ok? and #sleep_duration).
+#    (and also potentially #config_ok?, #sleep_duration, #before_regenerate_config, and #after_regenerate_config).
 #    See the documentation for those methods for what they need to do.
 #
 # 1. Setup any file watchers you want with .watch and #watch.
@@ -142,6 +143,18 @@ class ConfigSkeleton < ServiceSkeleton
   # If you get this, someone didn't read the documentation.
   class NotImplementedError < Error; end
 
+  # It is useful for consumers to manually request a config regen. An instance
+  # of this class is made via the regen_notifier method.
+  class ConfigRegenNotifier
+    def initialize(io_write)
+      @io_write = io_write
+    end
+
+    def trigger_regen
+      @io_write << "."
+    end
+  end
+
   # Declare a file watch on all instances of the config generator.
   #
   # When you're looking to watch a file whose path is well-known and never-changing, you
@@ -184,10 +197,23 @@ class ConfigSkeleton < ServiceSkeleton
 
     hook_signal(:HUP) do
       logger.info("SIGHUP") { "received SIGHUP, triggering config regeneration" }
-      regenerate_config(force_reload: true)
+      @trigger_regen_w << "."
     end
 
     initialize_config_skeleton_metrics
+    @trigger_regen_r, @trigger_regen_w = IO.pipe
+    @terminate_r, @terminate_w = IO.pipe
+  end
+
+  # Expose the write pipe which can be written to to trigger a config
+  # regeneration with a forced reload; a similar mechanism is used for
+  # shutdown but in that case writes are managed internally.
+  #
+  # Usage: config.regen_notifier.trigger_regen
+  #
+  # @return [ConfigRegenNotifier]
+  def regen_notifier
+    @regen_notifier ||= ConfigRegenNotifier.new(@trigger_regen_w)
   end
 
   # Set the config generator running.
@@ -206,10 +232,12 @@ class ConfigSkeleton < ServiceSkeleton
 
     logger.debug(logloc) { "notifier fd is #{notifier.to_io.inspect}" }
 
-    @terminate_r, @terminate_w = IO.pipe
-
     loop do
-      if ios = IO.select([notifier.to_io, @terminate_r], [], [], sleep_duration.tap { |d| logger.debug(logloc) { "Sleeping for #{d} seconds" } })
+      if ios = IO.select(
+          [notifier.to_io, @terminate_r, @trigger_regen_r],
+          [], [],
+          sleep_duration.tap { |d| logger.debug(logloc) { "Sleeping for #{d} seconds" } }
+      )
         if ios.first.include?(notifier.to_io)
           logger.debug(logloc) { "inotify triggered" }
           notifier.process
@@ -217,6 +245,14 @@ class ConfigSkeleton < ServiceSkeleton
         elsif ios.first.include?(@terminate_r)
           logger.debug(logloc) { "triggered by termination pipe" }
           break
+        elsif ios.first.include?(@trigger_regen_r)
+          # we want to wait until everything in the backlog is read
+          # before proceeding so we don't run out of buffer memory
+          # for the pipe
+          while @trigger_regen_r.read_nonblock(20, nil, exception: false) != :wait_readable; end
+
+          logger.debug(logloc) { "triggered by regen pipe" }
+          regenerate_config(force_reload: true)
         else
           logger.error(logloc) { "Mysterious return from select: #{ios.inspect}" }
         end
@@ -327,6 +363,27 @@ class ConfigSkeleton < ServiceSkeleton
     raise NotImplementedError, "config_data must be implemented in subclass."
   end
 
+  # Run code before the config is regenerated and the config_file
+  # is written.
+  #
+  # @param force_reload [Boolean] Whether the regenerate_config was called with force_reload
+  # @param existing_config_hash [String] MD5 hash of the config file before regeneration.
+  #
+  # @note this can optionally be implemented by subclasses.
+  #
+  def before_regenerate_config(force_reload:, existing_config_hash:, existing_config_data:); end
+
+  # Run code after the config is regenerated and potentially a new file is written.
+  #
+  # @param force_reload [Boolean] Whether the regenerate_config was called with force_reload
+  # @param config_was_different [Boolean] Whether the diff of the old and new config was different.
+  # @param config_was_cycled [Boolean] Whether a new config file was cycled in.
+  # @param new_config_hash [String] MD5 hash of the new config file after write.
+  #
+  # @note this can optionally be implemented by subclasses.
+  #
+  def after_regenerate_config(force_reload:, config_was_different:, config_was_cycled:, new_config_hash:); end
+
   # Verify that the currently running config is acceptable.
   #
   # In the event that a generated config is "bad", it may be possible to detect
@@ -408,29 +465,52 @@ class ConfigSkeleton < ServiceSkeleton
   # @return [void]
   #
   def regenerate_config(force_reload: false)
+    data = File.read(config_file)
+    existing_config_hash = Digest::MD5.hexdigest(data)
+    before_regenerate_config(
+      force_reload: force_reload,
+      existing_config_hash: existing_config_hash,
+      existing_config_data: data
+    )
+
     logger.debug(logloc) { "force? #{force_reload.inspect}" }
     tmpfile = Tempfile.new(service_name, File.dirname(config_file))
     logger.debug(logloc) { "Tempfile is #{tmpfile.path}" }
     unless (new_config = instrumented_config_data).nil?
       File.write(tmpfile.path, new_config)
       tmpfile.close
-      logger.debug(logloc) { require 'digest/md5'; "Existing config hash: #{Digest::MD5.hexdigest(File.read(config_file))}, new config hash: #{Digest::MD5.hexdigest(File.read(tmpfile.path))}" }
+
+      new_config_hash = Digest::MD5.hexdigest(File.read(tmpfile.path))
+      logger.debug(logloc) do
+        "Existing config hash: #{existing_config_hash}, new config hash: #{new_config_hash}"
+      end
 
       match_perms(config_file, tmpfile.path)
 
-      diff = Diffy::Diff.new(config_file, tmpfile.path, source: 'files', context: 3, include_diff_info: true)
-      if diff.to_s != ""
-        logger.info(logloc) { "Config has changed.  Diff:\n#{diff.to_s}" }
+      diff = Diffy::Diff.new(config_file, tmpfile.path, source: 'files', context: 3, include_diff_info: true).to_s
+      config_was_different = diff != ""
+
+      if config_was_different
+        logger.info(logloc) { "Config has changed.  Diff:\n#{diff}" }
       end
 
       if force_reload
         logger.debug(logloc) { "Forcing config reload because force_reload == true" }
       end
 
-      if force_reload || diff.to_s != ""
+      config_was_cycled = false
+      if force_reload || config_was_different
         cycle_config(tmpfile.path)
+        config_was_cycled = true
       end
     end
+
+    after_regenerate_config(
+      force_reload: force_reload,
+      config_was_different: config_was_different,
+      config_was_cycled: config_was_cycled,
+      new_config_hash: new_config_hash
+    )
   ensure
     metrics.last_change_timestamp.set({}, File.stat(config_file).mtime.to_f)
     tmpfile.close rescue nil

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: config_skeleton
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Matt Palmer
+- Discourse Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-01 00:00:00.000000000 Z
+date: 2020-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: diffy
@@ -95,7 +96,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: git-version-bump
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -109,21 +124,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: redcarpet
+  name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -137,7 +152,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -151,7 +166,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: yard
+  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: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -167,11 +196,14 @@ dependencies:
 description: 
 email:
 - matt.palmer@discourse.org
+- team@discourse.org
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ruby.yml"
 - ".gitignore"
+- ".rspec"
 - ".rubocop.yml"
 - ".yardopts"
 - CODE_OF_CONDUCT.md
@@ -198,8 +230,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Dynamically generate configs and reload servers