config_o_mat 0.1.0

data/lib/config_o_mat/configurator/op/refresh_all_profiles.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+# Copyright 2021 Teak.io, Inc.
+#
+# 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
+#
+#     https://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.
+
+require 'lifecycle_vm/op_base'
+
+module ConfigOMat
+  module Op
+    class RefreshAllProfiles < LifecycleVM::OpBase
+      reads :profile_defs, :applied_profiles, :client_id, :appconfig_client
+      writes :profiles_to_apply, :last_refresh_time
+
+      def call
+        self.profiles_to_apply = []
+        self.last_refresh_time = Time.now.to_i
+
+        profile_defs.each do |(profile_name, definition)|
+          request = {
+            application: definition.application, environment: definition.environment,
+            configuration: definition.profile, client_id: client_id
+          }
+
+          current_version = applied_profiles&.fetch(profile_name, nil)&.version
+          request[:client_configuration_version] = current_version if current_version
+
+          response =
+            begin
+              appconfig_client.get_configuration(request)
+            rescue StandardError => e
+              error profile_name, e
+              nil
+            end
+
+          next if response.nil?
+
+          loaded_version = response.configuration_version
+          next if current_version && loaded_version == current_version
+
+          logger&.notice(
+            :updated_profile,
+            name: profile_name, previous_version: current_version, new_version: loaded_version
+          )
+
+          profiles_to_apply << LoadedProfile.new(
+            profile_name, loaded_version, response.content.read, response.content_type
+          )
+        end
+      end
+    end
+  end
+end

data/lib/config_o_mat/configurator/op/refresh_profile.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+# Copyright 2021 Teak.io, Inc.
+#
+# 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
+#
+#     https://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.
+
+require 'lifecycle_vm/op_base'
+
+module ConfigOMat
+  module Op
+    class RefreshProfile < LifecycleVM::OpBase
+      reads :profile_defs, :client_id, :applying_profile, :appconfig_client
+      writes :applying_profile
+
+      def call
+        profile_name = applying_profile.name
+        profile_version = applying_profile.version
+        definition = profile_defs[profile_name]
+        request = {
+          application: definition.application, environment: definition.environment,
+          configuration: definition.profile, client_id: client_id,
+          client_configuration_version: profile_version
+        }
+
+        response =
+          begin
+            appconfig_client.get_configuration(request)
+          rescue StandardError => e
+            error profile_name, e
+            nil
+          end
+
+        return if response.nil? || errors?
+        loaded_version = response.configuration_version
+
+        if loaded_version == profile_version
+          logger&.warning(
+            :no_update,
+            name: profile_name, version: profile_version
+          )
+          return
+        end
+
+        logger&.notice(
+          :updated_profile,
+          name: profile_name, previous_version: profile_version, new_version: loaded_version
+        )
+
+        self.applying_profile = LoadedProfile.new(
+          profile_name, loaded_version, response.content.read, response.content_type
+        )
+      end
+    end
+  end
+end

data/lib/config_o_mat/configurator/op/reload_one_service.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+# Copyright 2021 Teak.io, Inc.
+#
+# 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
+#
+#     https://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.
+
+require 'lifecycle_vm/op_base'
+
+require 'config_o_mat/flip_flopper'
+
+require 'dbus'
+
+module ConfigOMat
+  module Op
+    class ReloadOneService < LifecycleVM::OpBase
+      reads :services_to_reload, :runtime_directory, :service_defs, :systemd_interface
+      writes :services_to_reload
+
+      def call
+        service = services_to_reload.pop
+        service_def = service_defs[service]
+
+        if service_def.restart_mode == :restart
+          do_restart(service, service_def)
+        else
+          do_flip_flop(service, service_def)
+        end
+      end
+
+    private
+
+      def do_restart(service, service_def)
+        unit = service_def.systemd_unit
+
+        file_path = File.join(runtime_directory, unit + '.restart')
+
+        logger&.notice(
+          :service_restart,
+          name: service, systemd_unit: unit, touched_path: file_path
+        )
+
+        FileUtils.touch(file_path)
+      end
+
+      def do_flip_flop(service, service_def)
+        mem = ConfigOMat::FlipFlopper::Memory.new(
+          runtime_directory: runtime_directory,
+          service: service_def.systemd_unit,
+          systemd_interface: systemd_interface,
+          logger: logger
+        )
+        vm = ConfigOMat::FlipFlopper::VM.new(mem)
+        vm.call
+
+        if vm.errors?
+          vm.errors.each do |(key, value)|
+            value.each { |v| error key, v }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/config_o_mat/configurator/op/stage_one_profile.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+# Copyright 2021 Teak.io, Inc.
+#
+# 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
+#
+#     https://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.
+
+require 'lifecycle_vm/op_base'
+
+module ConfigOMat
+  module Op
+    class StageOneProfile < LifecycleVM::OpBase
+      reads :profiles_to_apply
+      writes :applying_profile, :profiles_to_apply
+
+      def call
+        self.applying_profile = profiles_to_apply.pop
+
+        # We defer error checking to GenerateAllTemplates so that even if errored the profile gets set as
+        # the applying_profile, which simplifies retry logic.
+      end
+    end
+  end
+end

data/lib/config_o_mat/configurator/op/wait_retry.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+# Copyright 2021 Teak.io, Inc.
+#
+# 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
+#
+#     https://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.
+
+require 'lifecycle_vm/op_base'
+
+module ConfigOMat
+  module Op
+    class WaitRetry < LifecycleVM::OpBase
+      reads :retry_wait, :retry_count, :retries_left
+      writes :retries_left
+
+      def call
+        # Exponential backoff
+        wait = retry_wait * (2**(retry_count - retries_left))
+
+        # With jitter
+        wait += rand(retry_wait + 1) - (retry_wait / 2.0)
+
+        logger&.notice(:retry_wait, wait: wait)
+
+        # Calling Kernel.sleep directly for easy test stubbing
+        Kernel.sleep wait
+
+        self.retries_left -= 1
+      end
+    end
+  end
+end

data/lib/config_o_mat/configurator/op.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+# Copyright 2021 Teak.io, Inc.
+#
+# 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
+#
+#     https://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.
+
+Dir[File.join(__dir__, 'op', '*')].sort.each { |file| require file }

data/lib/config_o_mat/configurator.rb

@@ -0,0 +1,122 @@
+# frozen_string_literal: true
+
+# Copyright 2021 Teak.io, Inc.
+#
+# 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
+#
+#     https://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.
+
+require 'lifecycle_vm'
+
+require 'config_o_mat/shared/cond'
+require 'config_o_mat/shared/op'
+require 'config_o_mat/configurator/op'
+require 'config_o_mat/configurator/cond'
+require 'config_o_mat/configurator/memory'
+
+module ConfigOMat
+  module Configurator
+    class VM < LifecycleVM::VM
+      VERSION = "0.0.1"
+
+      memory_class ConfigOMat::Configurator::Memory
+      on_op_failure :op_failure
+      terminal :fail
+
+      on :start, do: Op::ParseCli, then: {
+        case: Cond::EarlyExit,
+        when: {
+          true => :exit,
+          false => :reading_meta_config
+        }
+      }
+
+      on :reading_meta_config, do: Op::LoadMetaConfig, then: :compiling_templates
+
+      on :compiling_templates, do: Op::CompileTemplates, then: :connecting_to_appconfig
+
+      on :connecting_to_appconfig, do: Op::ConnectToAppconfig, then: :refreshing_profiles
+
+      on :refreshing_profiles,
+         do: Op::RefreshAllProfiles,
+         then: {
+           case: Cond::FirstRun,
+           when: {
+             true => :initial_applying_profiles,
+             false => :applying_profiles
+           }
+         }
+
+      on :initial_applying_profiles, do: Op::ApplyAllProfiles, then: :generating_templates
+
+      on :applying_profiles,
+         then: {
+           case: Cond::ProfilesToApply,
+           when: {
+             true => :applying_profile,
+             false => :running
+           }
+         }
+
+      on :applying_profile, do: Op::StageOneProfile, then: :generating_templates
+
+      on :generating_templates, do: Op::GenerateAllTemplates, then: {
+        case: Cond::FirstRun,
+        when: {
+          true => :notifying_systemd,
+          false => :reloading_services
+        }
+      }
+
+      on :notifying_systemd, do: Op::NotifySystemdStart, then: :running
+
+      on :reloading_services,
+         then: {
+           case: Cond::ServicesToReload,
+           when: {
+             true => :reloading_service,
+             false => { do: Op::CommitStagedProfile, then: :applying_profiles }
+           }
+         }
+
+      on :reloading_service, do: Op::ReloadOneService, then: :reloading_services
+
+      on :running,
+         do: Op::NextTick,
+         then: {
+           case: Cond::NextState,
+           when: {
+             refreshing_profiles: :refreshing_profiles,
+             graceful_shutdown: :exit,
+             fail: :fail,
+             running: :running
+           }
+         }
+
+      on :op_failure,
+         then: {
+           case: Cond::FirstRun,
+           when: {
+             true => :fail,
+             false => {
+               case: Cond::RetriesLeft,
+               when: {
+                 true => { do: Op::WaitRetry, then: :refreshing_profile },
+                 false => :fail
+               }
+             }
+           }
+         }
+
+      on :refreshing_profile, do: Op::RefreshProfile, then: :applying_profile
+    end
+  end
+end

data/lib/config_o_mat/flip_flopper/cond/service_status.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+# Copyright 2021 Teak.io, Inc.
+#
+# 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
+#
+#     https://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.
+
+require 'lifecycle_vm/cond_base'
+
+module ConfigOMat
+  module Cond
+    class ServiceStatus < LifecycleVM::CondBase
+      reads :activation_status
+
+      def call
+        activation_status
+      end
+    end
+  end
+end

data/lib/config_o_mat/flip_flopper/cond.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+# Copyright 2021 Teak.io, Inc.
+#
+# 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
+#
+#     https://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.
+
+Dir[File.join(__dir__, 'cond', '*')].sort.each { |file| require file }

data/lib/config_o_mat/flip_flopper/memory.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+# Copyright 2021 Teak.io, Inc.
+#
+# 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
+#
+#     https://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.
+
+require 'lifecycle_vm'
+
+module ConfigOMat
+  module FlipFlopper
+    class Memory < LifecycleVM::Memory
+      attr_reader :systemd_interface, :service, :runtime_directory
+      attr_accessor :running_instance, :activating_instance, :activation_status, :activating_interface,
+                    :min_wait, :max_wait
+
+      def initialize(
+        systemd_interface: nil,
+        service: nil,
+        min_wait: 5,
+        max_wait: 30,
+        runtime_directory: nil,
+        running_instance: nil,
+        activating_instance: nil,
+        activation_status: nil,
+        activating_interface: nil,
+        logger: nil
+      )
+        @systemd_interface = systemd_interface
+        @service = service
+        @min_wait = min_wait
+        @max_wait = max_wait
+        @runtime_directory = runtime_directory
+        @running_instance = running_instance
+        @activating_instance = activating_instance
+        @activation_status = activation_status
+        @activating_interface = activating_interface
+        @logger = logger
+      end
+    end
+  end
+end

data/lib/config_o_mat/flip_flopper/op/check_service_status.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+# Copyright 2021 Teak.io, Inc.
+#
+# 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
+#
+#     https://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.
+
+require 'lifecycle_vm/op_base'
+
+module ConfigOMat
+  module Op
+    class CheckServiceStatus < LifecycleVM::OpBase
+      reads :service, :activating_instance, :activating_interface, :systemd_interface,
+            :min_wait, :max_wait
+      writes :activating_interface, :activation_status, :min_wait, :max_wait
+
+      def call
+        if min_wait > 0
+          do_sleep(min_wait)
+        else
+          do_sleep(1)
+        end
+
+        instance_name = "#{service}#{activating_instance}"
+
+        if !activating_interface
+          self.activating_interface = systemd_interface.service_interface(instance_name)
+        end
+
+        if !activating_interface
+          logger&.error(:ipc_failure, name: instance_name)
+          self.activation_status = :failed
+          return
+        end
+
+        reported_status = activating_interface['ActiveState']
+
+        logger&.info(:service_status, name: instance_name, status: reported_status)
+
+        if reported_status == 'active'
+          self.activation_status = :started
+        elsif reported_status == 'activating'
+          if max_wait > 0
+            self.activation_status = :starting
+          else
+            self.activation_status = :timed_out
+          end
+        else
+          self.activation_status = :failed
+        end
+      end
+
+    private
+
+      def do_sleep(secs)
+        # I'm calling Kernel.sleep directly so we can easily stub it out.
+        ::Kernel.sleep secs
+        self.min_wait -= secs
+        self.max_wait -= secs
+      end
+    end
+  end
+end

data/lib/config_o_mat/flip_flopper/op/determine_running_instance.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+# Copyright 2021 Teak.io, Inc.
+#
+# 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
+#
+#     https://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.
+
+require 'lifecycle_vm/op_base'
+
+module ConfigOMat
+  module Op
+    class DetermineRunningInstance < LifecycleVM::OpBase
+      reads :systemd_interface, :service
+      writes :running_instance, :activating_instance
+
+      RUNNING_STATES = %w[active activating reloading].freeze
+
+      def call
+        i1_name = "#{service}1"
+        i1_status = systemd_interface.service_status(i1_name)
+        logger&.info(:service_status, name: i1_name, status: i1_status)
+
+        i2_name = "#{service}2"
+        i2_status = systemd_interface.service_status(i2_name)
+        logger&.info(:service_status, name: i2_name, status: i2_status)
+
+        i1_running = RUNNING_STATES.include?(i1_status)
+        i2_running = RUNNING_STATES.include?(i2_status)
+
+        if i1_running && i2_running
+          error :service, 'both instances are currently running!'
+        elsif i1_running
+          self.activating_instance = 2
+          self.running_instance = 1
+        elsif i2_running
+          self.activating_instance = 1
+          self.running_instance = 2
+        else
+          # If neither version is up, attempt to bring up instance 1. Our attempt to stop
+          # instance 2 will be a noop.
+          self.activating_instance = 1
+          self.running_instance = 2
+        end
+      end
+    end
+  end
+end

data/lib/config_o_mat/flip_flopper/op/report_failure.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+# Copyright 2021 Teak.io, Inc.
+#
+# 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
+#
+#     https://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.
+
+require 'lifecycle_vm/op_base'
+
+module ConfigOMat
+  module Op
+    class ReportFailure < LifecycleVM::OpBase
+      reads :activation_status
+
+      def call
+        case activation_status
+        when :failed
+          error :service, 'failed to start service instance'
+        when :timed_out
+          error :service, 'service instance did not start within timeout'
+        else
+          error :service, "service instance failed due to an unknown error (#{activation_status})"
+        end
+      end
+    end
+  end
+end