ufo 6.2.5 → 6.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 69d0e411c4b48b8ec8a0a2148caf5501b3c038cb991585c4741027579a102e0c
-  data.tar.gz: f080bdf97e783b18bc54723ced3be52557b0749094451561de41766c052aba0e
+  metadata.gz: 91051471ac72ee1a31948333cc0009d51f1d6ca1e1e170abe54d492a94a046f5
+  data.tar.gz: 4aa76fab580eb121d8e257fa7461d3be171334d2be1037bd0365988065e03f8a
 SHA512:
-  metadata.gz: 860f1d782b915338e903d2c2c0cad43fbe4a915261b46a2b615a7d24870247170a3041de32b6e9de8b11161da1c8447dc3d12683e9179c8c6cd0af7ef3dc4d77
-  data.tar.gz: c02bc1f698f85055e2e1c99b7fbf6cf730044e23b7584509a5c2e66bd79259097b2c5ccf1706b186a64b329db31e5678fe6eacb3f120724dbfa896a0ab6fbb00
+  metadata.gz: 90f134dd07a15a153b7e8f4fe82d4c12dccbaea80e2041e5ff23431bacd28a78a5077d1ba5e4a8508926bfb91510ff0113e185658d444981730dc32447f552f1
+  data.tar.gz: af3e344e51334b7c3dd6a82fb23403da39717fb77bb15883632146ca79a3b4edc57a61dedd260d42b52d6652c4a129389acbac1009444c9da140fefb1d77ace2

data/CHANGELOG.md

@@ -3,6 +3,9 @@
 All notable changes to this project will be documented in this file.
 This project *tries* to adhere to [Semantic Versioning](http://semver.org/), even before v1.0.
 
+## [6.3.0] - 2022-03-25
+- [#162](https://github.com/tongueroo/ufo/pull/162) hooks support
+
 ## [6.2.5] - 2022-03-24
 - [#159](https://github.com/tongueroo/ufo/pull/159) improve ufo call line
 - [#160](https://github.com/tongueroo/ufo/pull/160) conventionally lookup up secrets and env file

data/lib/templates/hooks/docker.rb

@@ -0,0 +1,9 @@
+# Docs: https://ufoships.com/docs/config/hooks/docker/
+
+before("build",
+  execute: "echo 'docker build before hook'",
+)
+
+after("build",
+  execute: "echo 'docker build after hook'",
+)

data/lib/templates/hooks/ufo.rb

@@ -0,0 +1,9 @@
+# Docs: https://ufoships.com/docs/config/hooks/ufo/
+
+before("ship",
+  execute: "echo 'ufo before ship hook'",
+)
+
+after("ship",
+  execute: "echo 'ufo after ship hook'",
+)

data/lib/ufo/autoloader.rb

@@ -4,7 +4,7 @@ module Ufo
   class Autoloader
     class Inflector < Zeitwerk::Inflector
       def camelize(basename, _abspath)
-        map = { cli: "CLI", dsl: "DSL", version: "VERSION" }
+        map = { cli: "CLI", version: "VERSION" }
         map[basename.to_sym] || super
       end
     end

data/lib/ufo/cfn/stack/builder/resources/iam_roles/base.rb

@@ -1,7 +1,7 @@
 module Ufo::Cfn::Stack::Builder::Resources::IamRoles
   class Base < Ufo::Cfn::Stack::Builder::Base
     def build
-      return unless self.class.build? # important because it runs DSL#evaluate
+      return unless self.class.build? # important because it runs Dsl#evaluate
       Ufo::IamRole::Builder.new(self.class.role_type).build
     end
 
@@ -13,7 +13,7 @@ module Ufo::Cfn::Stack::Builder::Resources::IamRoles
       def build?
         path = lookup_path
         return unless path.nil? || File.exist?(path)
-        Ufo::IamRole::DSL.new(path).evaluate # runs the role.rb and registers items
+        Ufo::IamRole::Dsl.new(path).evaluate # runs the role.rb and registers items
         Ufo::IamRole::Builder.new(role_type).build?
       end
 

data/lib/ufo/cfn/stack.rb

@@ -25,6 +25,7 @@ module Ufo::Cfn
   class Stack < Base
     extend Memoist
     include Ufo::TaskDefinition::Helpers::AwsHelper
+    include Ufo::Hooks::Concern
 
     def deploy
       build
@@ -39,15 +40,14 @@ module Ufo::Cfn
 
       exit_with_message(@stack) if @stack && !updatable?(@stack)
 
-      @stack ? perform(:update) : perform(:create)
-
-      stop_old_tasks if @options[:stop_old_task]
-
-      return unless @options[:wait]
-      status.wait
+      run_hooks(name: "ship", file: "ufo.rb") do
+        @stack ? perform(:update) : perform(:create)
+        stop_old_tasks if @options[:stop_old_task]
+        return unless @options[:wait]
+        status.wait
+      end
 
       logger.info status.rollback_error_message if status.update_rollback?
-
       status.success?
     end
 
@@ -78,13 +78,17 @@ module Ufo::Cfn
       end
     end
 
+    # Run hooks here so both ufo docker and ufo ship runs it
+    #     ufo docker => CLI::Build#build => Cfn::Stack#build
     def build
-      vars = Vars.new(@options).values
-      options_with_vars = @options.dup.merge(vars: vars)
-      params = Params.new(options_with_vars)
-      @parameters = params.build
-      template = Template.new(options_with_vars)
-      @template_body = template.body
+      run_hooks(name: "build", file: "ufo.rb") do
+        vars = Vars.new(@options).values
+        options_with_vars = @options.dup.merge(vars: vars)
+        params = Params.new(options_with_vars)
+        @parameters = params.build
+        template = Template.new(options_with_vars)
+        @template_body = template.body
+      end
     end
 
     def scheduling_strategy

data/lib/ufo/cli/build.rb

@@ -7,11 +7,6 @@ class Ufo::CLI
     end
     alias_method :all, :build
 
-    def for_deploy
-      docker
-      task_definition
-    end
-
     def task_definition
       Ufo::TaskDefinition::Builder.new(@options).build
     end

data/lib/ufo/cli/destroy.rb

@@ -1,27 +1,30 @@
 class Ufo::CLI
   class Destroy < Base
+    include Ufo::Hooks::Concern
+
     def run
       are_you_sure?
 
       stack = find_stack(@stack_name)
       unless stack
-        puts "Stack #{@stack_name.color(:green)} does not exist."
+        logger.info "Stack #{@stack_name.color(:green)} does not exist."
         exit 1
       end
 
       if stack.stack_status =~ /_IN_PROGRESS$/
-        puts "Cannot destroy service #{@service.color(:green)}"
-        puts "Cannot delete stack #{@stack_name.color(:green)} in this state: #{stack.stack_status.color(:green)}"
-        puts "If the stack is taking a long time, you can cancel the current operation with:"
-        puts "    ufo cancel #{@service}"
+        logger.info "Cannot destroy service #{@service.color(:green)}"
+        logger.info "Cannot delete stack #{@stack_name.color(:green)} in this state: #{stack.stack_status.color(:green)}"
+        logger.info "If the stack is taking a long time, you can cancel the current operation with:"
+        logger.info "    ufo cancel #{@service}"
         return
       end
 
-      cfn.delete_stack(stack_name: @stack_name)
-      puts "Deleting stack #{@stack_name.color(:green)}"
-
-      return unless @options[:wait]
-      status.wait
+      run_hooks(name: "destroy", file: "ufo.rb") do
+        cfn.delete_stack(stack_name: @stack_name)
+        logger.info "Deleting stack #{@stack_name.color(:green)}"
+        return unless @options[:wait]
+        status.wait
+      end
     end
 
     def are_you_sure?

data/lib/ufo/cli/help/new/hook.md

@@ -0,0 +1,7 @@
+## Examples
+
+    $ ufo new hook docker
+          create  .ufo/config/hooks/docker.rb
+    $ ufo new hook ufo
+          create  .ufo/config/hooks/ufo.rb
+    $

data/lib/ufo/cli/new/hook.rb

@@ -0,0 +1,18 @@
+class Ufo::CLI::New
+  class Hook < Sequence
+    argument :type, default: "ufo", description: "IE: docker, ufo" # description doesnt really show up
+
+    def self.cli_options
+      [
+        [:force, aliases: ["y"], type: :boolean, desc: "Bypass overwrite are you sure prompt for existing files"],
+      ]
+    end
+    cli_options.each { |args| class_option(*args) }
+
+  public
+    def create_hook
+      set_template_source("hooks")
+      template "#{type}.rb", ".ufo/config/hooks/#{type}.rb"
+    end
+  end
+end

data/lib/ufo/cli/new.rb

@@ -1,17 +1,24 @@
 class Ufo::CLI
   class New < Ufo::Command
-    desc "boot_hook", "Generate boot_hook file"
+    desc "boot_hook", "Generate boot_hook"
     long_desc Help.text("new/boot_hook")
     BootHook.cli_options.each do |args|
       option(*args)
     end
-    register(BootHook, "boot_hook", "boot_hook", "Generate boot_hook file")
+    register(BootHook, "boot_hook", "boot_hook", "Generate boot_hook")
 
-    desc "helper", "Generate helper file"
+    desc "helper", "Generate helper"
     long_desc Help.text("new/helper")
     Helper.cli_options.each do |args|
       option(*args)
     end
-    register(Helper, "helper", "helper", "Generate helper file")
+    register(Helper, "helper", "helper", "Generate helper")
+
+    desc "hook", "Generate hook"
+    long_desc Help.text("new/hook")
+    Hook.cli_options.each do |args|
+      option(*args)
+    end
+    register(Hook, "hook", "hook", "Generate hook")
   end
 end

data/lib/ufo/config.rb

@@ -85,6 +85,9 @@ module Ufo
       config.exec.command = "/bin/bash" # aws ecs execute-command cli
       config.exec.enabled = true        # EcsService EnableExecuteCommand
 
+      config.hooks = ActiveSupport::OrderedOptions.new
+      config.hooks.show = true
+
       config.layering = ActiveSupport::OrderedOptions.new
       config.layering.show = parsed_layering_show
       config.layering.show_for_commands = parsed_layering_show_for

data/lib/ufo/docker/builder.rb

@@ -2,6 +2,7 @@ module Ufo::Docker
   class Builder
     extend Memoist
     include Concerns
+    include Ufo::Hooks::Concern
 
     delegate :push, to: :pusher
     def self.build(options={})
@@ -28,7 +29,10 @@ module Ufo::Docker
       update_auth_token
       command = "docker build #{build_options}-t #{docker_image} -f #{@dockerfile} ."
       log = ".ufo/log/docker.log" if @options[:quiet]
-      success = execute(command, log: log)
+      success = nil
+      run_hooks(name: "build", file: "docker.rb") do
+        success = execute(command, log: log)
+      end
       unless success
         docker_version_success = system("docker version > /dev/null 2>&1")
         unless docker_version_success

data/lib/ufo/docker/pusher.rb

@@ -1,6 +1,7 @@
 module Ufo::Docker
   class Pusher
     include Concerns
+    include Ufo::Hooks::Concern
 
     delegate :docker_image, to: :builder
     attr_reader :last_image_name
@@ -17,7 +18,10 @@ module Ufo::Docker
       logger.info "Pushing Docker Image"
       command = "docker push #{last_image_name}"
       log = ".ufo/log/docker.log" if @options[:quiet]
-      success = execute(command, log: log)
+      success = nil
+      run_hooks(name: "push", file: "docker.rb") do
+        success = execute(command, log: log)
+      end
       unless success
         logger.info "ERROR: The docker image fail to push.".color(:red)
         exit 1

data/lib/ufo/hooks/builder.rb

@@ -0,0 +1,51 @@
+module Ufo::Hooks
+  class Builder
+    extend Memoist
+    include Dsl
+    include DslEvaluator
+    include Ufo::Utils::Logging
+
+    attr_accessor :name
+    def initialize(options={})
+      @options = options
+      @file = options[:file] # IE: docker.rb
+      @dsl_file = "#{Ufo.root}/.ufo/config/hooks/#{@file}"
+      @name = options[:name].to_s
+      @hooks = {before: {}, after: {}}
+    end
+
+    def build
+      evaluate_file(@dsl_file)
+      @hooks.deep_stringify_keys!
+    end
+    memoize :build
+
+    def run_hooks
+      build
+      run_each_hook("before")
+      out = yield if block_given?
+      run_each_hook("after")
+      out
+    end
+
+    def run_each_hook(type)
+      hooks = @hooks.dig(type, @name) || []
+      hooks.each do |hook|
+        run_hook(type, hook)
+      end
+    end
+
+    def run_hook(type, hook)
+      return unless run?(hook)
+
+      id = "#{type} #{@name}"
+      label = " label: #{hook["label"]}" if hook["label"]
+      logger.info  "Hook: Running #{id} hook#{label}".color(:cyan) if Ufo.config.hooks.show
+      Runner.new(hook).run
+    end
+
+    def run?(hook)
+      !!hook["execute"]
+    end
+  end
+end

data/lib/ufo/hooks/concern.rb

@@ -0,0 +1,10 @@
+module Ufo::Hooks
+  module Concern
+    # options example: {name: "build", file: "docker.rb"}
+    def run_hooks(options={}, &block)
+      hooks = Ufo::Hooks::Builder.new(options)
+      hooks.build # build hooks
+      hooks.run_hooks(&block)
+    end
+  end
+end

data/lib/ufo/hooks/dsl.rb

@@ -0,0 +1,20 @@
+module Ufo::Hooks
+  module Dsl
+    def before(*commands, **props)
+      commands.each do |name|
+        each_hook(:before, name, props)
+      end
+    end
+
+    def after(*commands, **props)
+      commands.each do |name|
+        each_hook(:after, name, props)
+      end
+    end
+
+    def each_hook(type, name, props={})
+      @hooks[type][name] ||= []
+      @hooks[type][name] << props
+    end
+  end
+end

data/lib/ufo/hooks/runner.rb

@@ -0,0 +1,37 @@
+module Ufo::Hooks
+  class Runner
+    include Ufo::Utils::Logging
+    include Ufo::Utils::Execute
+
+    attr_reader :hook
+    def initialize(hook)
+      @hook = hook
+      @execute = @hook["execute"]
+    end
+
+    def run
+      case @execute
+      when String
+        execute(@execute, exit_on_fail: @hook["exit_on_fail"])
+      when -> (e) { e.respond_to?(:public_instance_methods) && e.public_instance_methods.include?(:call) }
+        executor = @execute.new
+      when -> (e) { e.respond_to?(:call) }
+        executor = @execute
+      else
+        logger.warn "WARN: execute option not set for hook: #{@hook.inspect}"
+      end
+
+      return unless executor
+
+      meth = executor.method(:call)
+      case meth.arity
+      when 0
+        executor.call # backwards compatibility
+      when 1
+        executor.call(self)
+      else
+        raise "The #{executor} call method definition has been more than 1 arguments and is not supported"
+      end
+    end
+  end
+end

data/lib/ufo/iam_role/dsl.rb

@@ -1,5 +1,5 @@
 module Ufo::IamRole
-  class DSL
+  class Dsl
     include DslEvaluator
     include Ufo::TaskDefinition::Helpers::AwsHelper
 

data/lib/ufo/iam_role/registry.rb

@@ -11,13 +11,13 @@ module Ufo::IamRole
       def register_policy(role_type, policy_name, *statements)
         statements.flatten!
         self.policies[role_type] ||= Set.new
-        self.policies[role_type].add([policy_name, statements]) # using set so DSL can safely be evaluated multiple times
+        self.policies[role_type].add([policy_name, statements]) # using set so Dsl can safely be evaluated multiple times
       end
 
       def register_managed_policy(role_type, *policies)
         policies.flatten!
         self.managed_policies[role_type] ||= Set.new
-        self.managed_policies[role_type].merge(policies) # using set so DSL can safely be evaluated multiple times
+        self.managed_policies[role_type].merge(policies) # using set so Dsl can safely be evaluated multiple times
       end
     end
   end

data/lib/ufo/param.rb

@@ -18,8 +18,7 @@ module Ufo
     memoize :data
 
     def template_scope
-      self # TODO: add access to helpers like network
-      # @template_scope ||= Ufo::TemplateScope.new(Ufo::DSL::Helper.new, nil)
+      self
     end
   end
 end

data/lib/ufo/version.rb

@@ -1,3 +1,3 @@
 module Ufo
-  VERSION = "6.2.5"
+  VERSION = "6.3.0"
 end

data/spec/ufo/iam_role/builder_spec.rb

@@ -12,7 +12,7 @@ describe Ufo::IamRole::Builder do
       {:Action=>["cloudwatch:PutMetricData"], :Effect=>"Allow", :Resource=>"*"}
     )
     # Called twice on purpose to show that duplicated items in the set wont create doubles.
-    # This allows the DSL evaluate to be ran multiple times.
+    # This allows the Dsl evaluate to be ran multiple times.
     Ufo::IamRole::Registry.register_policy("task_role",
       "CloudwatchWrite",
       {:Action=>["cloudwatch:PutMetricData"], :Effect=>"Allow", :Resource=>"*"}

data/spec/ufo/iam_role/dsl_spec.rb

@@ -1,9 +1,9 @@
-describe Ufo::IamRole::DSL do
+describe Ufo::IamRole::Dsl do
   let(:dsl) { described_class.new(path) }
   let(:path) { "spec/fixtures/iam_roles/task_role.rb" }
 
   context "evaluate" do
-    it "registers policies from role DSL" do
+    it "registers policies from role Dsl" do
       dsl.evaluate
       expect(Ufo::IamRole::Registry.policies).not_to be_empty
       expect(Ufo::IamRole::Registry.managed_policies).not_to be_empty

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ufo
 version: !ruby/object:Gem::Version
-  version: 6.2.5
+  version: 6.3.0
 platform: ruby
 authors:
 - Tung Nguyen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-03-24 00:00:00.000000000 Z
+date: 2022-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-logs
@@ -480,6 +480,8 @@ files:
 - lib/templates/boot_hook/.ufo/config/boot.rb
 - lib/templates/docker/Dockerfile
 - lib/templates/helper/%underscore_name%_helper.rb.tt
+- lib/templates/hooks/docker.rb
+- lib/templates/hooks/ufo.rb
 - lib/templates/init/.ufo/config.rb.tt
 - lib/templates/init/.ufo/config/web/base.rb
 - lib/templates/init/.ufo/config/web/dev.rb
@@ -559,6 +561,7 @@ files:
 - lib/ufo/cli/help/init.md
 - lib/ufo/cli/help/logs.md
 - lib/ufo/cli/help/new/boot_hook.md
+- lib/ufo/cli/help/new/hook.md
 - lib/ufo/cli/help/ps.md
 - lib/ufo/cli/help/releases.md
 - lib/ufo/cli/help/rollback.md
@@ -570,6 +573,7 @@ files:
 - lib/ufo/cli/new/boot_hook.rb
 - lib/ufo/cli/new/concerns.rb
 - lib/ufo/cli/new/helper.rb
+- lib/ufo/cli/new/hook.rb
 - lib/ufo/cli/new/init.rb
 - lib/ufo/cli/new/sequence.rb
 - lib/ufo/cli/opts.rb
@@ -614,6 +618,10 @@ files:
 - lib/ufo/ext.rb
 - lib/ufo/ext/core/module.rb
 - lib/ufo/ext/core/nil_class.rb
+- lib/ufo/hooks/builder.rb
+- lib/ufo/hooks/concern.rb
+- lib/ufo/hooks/dsl.rb
+- lib/ufo/hooks/runner.rb
 - lib/ufo/iam_role/builder.rb
 - lib/ufo/iam_role/dsl.rb
 - lib/ufo/iam_role/registry.rb