hippo-cli 1.1.1 → 1.2.3

data/cli/status.rb

@@ -3,10 +3,6 @@
 command :status do
   desc 'Show current status of the namespace'
 
-  option '-h', '--hippofile [RECIPE]', 'The path to the Hippofile (defaults: ./Hippofile)' do |value, options|
-    options[:hippofile] = value.to_s
-  end
-
   option '--full', 'Include all relevant objects in namespace' do |_value, options|
     options[:full] = true
   end

data/cli/tidy.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+command :tidy do
+  desc 'Remove live objects that are not referenced by the manifest'
+  action do |context|
+    require 'hippo/cli'
+    cli = Hippo::CLI.setup(context)
+    cli.preflight
+
+    objects_to_prune = cli.stage.live_objects(pruneable_only: true)
+    if objects_to_prune.empty?
+      puts 'There are no objects to tidy'
+      exit 0
+    end
+
+    puts "Found #{objects_to_prune.size} object(s) to tidy"
+    puts
+    objects_to_prune.each do |obj|
+      $stdout.print '  ' + obj[:live].kind.ljust(25)
+      $stdout.print obj[:live].name
+      puts
+    end
+    puts
+
+    require 'hippo/util'
+    unless Hippo::Util.confirm('Do you wish to continue?')
+      puts 'No problem, not removing anything right now'
+      exit 0
+    end
+
+    cli.stage.delete_pruneable_objects
+  end
+end

data/cli/update.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+command :update do
+  desc 'Get the latest updates from the remote manifest'
+  action do
+    require 'hippo/working_directory'
+    wd = Hippo::WorkingDirectory.new
+
+    unless wd.can_update?
+      puts "No need to update #{wd.source_type} manifests"
+      exit 0
+    end
+
+    if wd.last_updated_at
+      puts "Last updated: #{wd.last_updated_at}"
+    else
+      puts 'Does not exist yet. Downloading for the first time.'
+    end
+
+    wd.update_from_remote(verbose: true)
+  end
+end

data/cli/vars.rb

@@ -3,10 +3,6 @@
 command :vars do
   desc 'Show all variables available for use in this stage'
 
-  option '-h', '--hippofile [RECIPE]', 'The path to the Hippofile (defaults: ./Hippofile)' do |value, options|
-    options[:hippofile] = value.to_s
-  end
-
   action do |context|
     require 'hippo/cli'
     cli = Hippo::CLI.setup(context)

data/lib/hippo.rb

@@ -35,4 +35,11 @@ module Hippo
 
     stdout.strip
   end
+
+  # Path to store temp files
+  #
+  # @return [String]
+  def self.tmp_root
+    File.join(ENV['HOME'], '.hippo')
+  end
 end

data/lib/hippo/bootstrap_parser.rb

@@ -2,6 +2,7 @@
 
 require 'securerandom'
 require 'secure_random_string'
+require 'openssl'
 
 module Hippo
   class BootstrapParser
@@ -54,6 +55,27 @@ module Hippo
         SecureRandom.hex(value['size'] ? value['size'].to_i : 16)
       when 'random'
         Base64.encode64(SecureRandom.random_bytes(value['size'] ? value['size'].to_i : 16)).strip
+      when 'rsa'
+        OpenSSL::PKey::RSA.new(value['size'] ? value['size'].to_i : 2048).to_s
+      when 'certificate'
+        key = OpenSSL::PKey::RSA.new(value['key_size'] ? value['key_size'].to_i : 2048)
+
+        cert = OpenSSL::X509::Certificate.new
+        cert.subject = cert.issuer = OpenSSL::X509::Name.new(
+          [
+            ['C', value['country'] || 'GB'],
+            ['O', value['organization'] || 'Default'],
+            ['OU', value['organization_unit'] || 'Default'],
+            ['CN', value['common_name'] || 'default']
+          ]
+        )
+        cert.not_before = Time.now
+        cert.not_after = Time.now + (60 * 60 * 24 * (value['days'] ? value['days'].to_i : 730))
+        cert.public_key = key.public_key
+        cert.serial = 0x0
+        cert.version = 2
+        cert.sign key, OpenSSL::Digest::SHA256.new
+        { 'certificate' => cert.to_s, 'key' => key.to_s }
       when nil
         raise Error, "A 'type' must be provided for each generated item"
       else

data/lib/hippo/cli.rb

@@ -3,28 +3,32 @@
 require 'securerandom'
 require 'hippo/manifest'
 require 'hippo/deployment_monitor'
+require 'hippo/working_directory'
 
 module Hippo
   class CLI
-    attr_reader :manifest
+    attr_reader :wd
     attr_reader :stage
 
     # Initialize a new CLI instance
     #
-    # @param manifest [Hippo::Manifest]
-    # @param stage [Hippo::Stage]
+    # @param wd [Hippo::WorkingDirectory]
     # @return [Hippo::CLI]
-    def initialize(manifest, stage)
-      @manifest = manifest
+    def initialize(wd, stage)
+      @wd = wd
       @stage = stage
     end
 
+    def manifest
+      wd.manifest
+    end
+
     # Verify image existence
     #
     # @return [void]
     def verify_image_existence
       missing = 0
-      @stage.images.each do |_, image|
+      stage.images.each do |_, image|
         if image.exists?
           puts "Image for #{image.name} exists at #{image.image_url}"
         else
@@ -43,7 +47,7 @@ module Hippo
     #
     # @return [void]
     def preflight
-      if @stage.context.nil?
+      if stage.context.nil?
         puts "\e[33mStage does not specify a context. The current context specified"
         puts "by the kubectl config will be used (#{Hippo.current_kubectl_context}).\e[0m"
         puts
@@ -61,9 +65,9 @@ module Hippo
         {
           'kind' => 'Namespace',
           'apiVersion' => 'v1',
-          'metadata' => { 'name' => @stage.namespace, 'labels' => { 'name' => @stage.namespace } }
+          'metadata' => { 'name' => stage.namespace, 'labels' => { 'name' => stage.namespace } }
         },
-        @stage
+        stage
       )
       apply([od], 'namespace')
     end
@@ -72,19 +76,19 @@ module Hippo
     #
     # @return [void]
     def apply_config
-      apply(@stage.configs, 'configuration')
+      apply(stage.configs, 'configuration')
     end
 
     # Install all packages
     #
     # @return [void]
     def install_all_packages
-      if @stage.packages.empty?
+      if stage.packages.empty?
         puts 'There are no packages to install'
         return
       end
 
-      @stage.packages.values.each do |package|
+      stage.packages.values.each do |package|
         if package.installed?
           puts "#{package.name} is already installed. Upgrading..."
           package.upgrade
@@ -94,14 +98,14 @@ module Hippo
         end
       end
 
-      puts "Finished with #{@stage.packages.size} #{@stage.packages.size == 1 ? 'package' : 'packages'}"
+      puts "Finished with #{stage.packages.size} #{stage.packages.size == 1 ? 'package' : 'packages'}"
     end
 
     # Apply all services, ingresses and policies
     #
     # @return [void]
     def apply_services
-      apply(@stage.services, 'service')
+      apply(stage.services, 'service')
     end
 
     # Run all deploy jobs
@@ -123,7 +127,7 @@ module Hippo
     # @return [void]
     def deploy
       deployment_id = SecureRandom.hex(6)
-      deployments = @stage.deployments
+      deployments = stage.deployments
       if deployments.empty?
         puts 'There are no deployment objects defined'
         return true
@@ -138,7 +142,7 @@ module Hippo
       apply(deployments, 'deployment')
       puts 'Waiting for all deployments to roll out...'
 
-      monitor = DeploymentMonitor.new(@stage, deployment_id)
+      monitor = DeploymentMonitor.new(stage, deployment_id)
       monitor.on_success do |poll|
         if poll.replica_sets.size == 1
           puts "\e[32mDeployment rolled out successfully\e[0m"
@@ -158,8 +162,8 @@ module Hippo
         poll.pending.each do |rs|
           puts
           name = rs.name.split('-').first
-          puts "  hippo #{@stage.name} kubectl -- describe deployment \e[35m#{name}\e[0m"
-          puts "  hippo #{@stage.name} kubectl -- logs deployment/\e[35m#{name}\e[0m --all-containers"
+          puts "  hippo #{stage.name} kubectl -- describe deployment \e[35m#{name}\e[0m"
+          puts "  hippo #{stage.name} kubectl -- logs deployment/\e[35m#{name}\e[0m --all-containers"
         end
         puts
       end
@@ -174,25 +178,25 @@ module Hippo
         puts "No #{type} objects found to apply"
       else
         puts "Applying #{objects.size} #{type} #{objects.size == 1 ? 'object' : 'objects'}"
-        @stage.apply(objects)
+        stage.apply(objects)
       end
     end
 
     def run_jobs(type)
       puts "Running #{type} jobs"
-      jobs = @stage.jobs(type)
+      jobs = stage.jobs(type)
       if jobs.empty?
         puts "There are no #{type} jobs to run"
         return true
       end
 
       jobs.each do |job|
-        @stage.delete('job', job.name)
+        stage.delete('job', job.name)
       end
 
       applied_jobs = apply(jobs, 'deploy job')
 
-      timeout, jobs = @stage.wait_for_jobs(applied_jobs.keys)
+      timeout, jobs = stage.wait_for_jobs(applied_jobs.keys)
       success_jobs = []
       failed_jobs = []
       jobs.each do |job|
@@ -221,22 +225,22 @@ module Hippo
                else
                  '❌'
                end
-        puts "  #{icon}  hippo #{@stage.name} kubectl -- logs job/#{job.name}"
+        puts "  #{icon}  hippo #{stage.name} kubectl -- logs job/#{job.name}"
       end
       puts
       result
     end
 
     class << self
-      def setup(context)
-        manifest = Hippo::Manifest.load_from_file(context.options[:hippofile] || './Hippofile')
+      def setup(_context)
+        wd = Hippo::WorkingDirectory.new
 
-        stage = manifest.stages[CURRENT_STAGE]
+        stage = wd.stages[CURRENT_STAGE]
         if stage.nil?
           raise Error, "Invalid stage name `#{CURRENT_STAGE}`. Check this has been defined in in your stages directory with a matching name?"
         end
 
-        new(manifest, stage)
+        new(wd, stage)
       end
     end
   end

data/lib/hippo/image.rb

@@ -34,7 +34,11 @@ module Hippo
     end
 
     def image_url
-      "#{host}/#{image_name}:#{tag}"
+      if host
+        "#{host}/#{image_name}:#{tag}"
+      else
+        "#{image_name}:#{tag}"
+      end
     end
 
     def template_vars
@@ -52,6 +56,8 @@ module Hippo
     end
 
     def exists?
+      return true unless tag.is_a?(RepositoryTag)
+      return true if host.nil?
       return true unless can_check_for_existence?
 
       credentials = Hippo.config.dig('docker', 'credentials', host)

data/lib/hippo/liquid_filters.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Hippo
+  module LiquidFilters
+    def indent(text, depth = 2)
+      text.split("\n").map.each_with_index do |p, i|
+        i == 0 ? p : ' ' * depth + p
+      end.join("\n")
+    end
+
+    def multiline(text)
+      text.inspect
+    end
+  end
+end

data/lib/hippo/manifest.rb

@@ -36,6 +36,10 @@ module Hippo
       @options['console']
     end
 
+    def commands
+      @options['commands'] || {}
+    end
+
     def config
       @options['config'] || {}
     end
@@ -51,6 +55,18 @@ module Hippo
       end
     end
 
+    def readme
+      return @readme if instance_variable_defined?('@readme')
+
+      path = File.join(@root, 'readme.txt')
+      unless File.file?(path)
+        @readme = nil
+        return
+      end
+
+      @readme = File.read(path)
+    end
+
     def template_vars
       {
         'name' => name
@@ -63,29 +79,13 @@ module Hippo
       @options['images']
     end
 
-    # Load all stages that are available in the manifest
-    #
-    # @return [Hash<Symbol, Hippo::Stage>]
-    def stages
-      objects('stages').each_with_object({}) do |(_, objects), hash|
-        objects.each do |obj|
-          stage = Stage.new(self, obj)
-          hash[stage.name] = stage
-        end
-      end
-    end
-
     # Load all YAML objects at a given path and return them.
     #
     # @param path [String]
     # @param decorator [Proc] an optional parser to run across the raw YAML file
     # @return [Array<Hash>]
     def objects(path, decorator: nil)
-      files = Dir[File.join(@root, path, '*.{yaml,yml}')]
-      files.each_with_object({}) do |path, objects|
-        file = Util.load_yaml_from_file(path, decorator: decorator)
-        objects[path.sub(%r{\A#{@root}/}, '')] = file
-      end
+      Util.load_objects_from_path(File.join(@root, path, '*.{yaml,yml}'), decorator: decorator)
     end
   end
 end

data/lib/hippo/object_definition.rb

@@ -30,7 +30,7 @@ module Hippo
     end
 
     def yaml
-      @object.to_yaml
+      @object.to_yaml(line_width: -1)
     end
 
     def yaml_to_apply

data/lib/hippo/package.rb

@@ -93,7 +93,7 @@ module Hippo
     end
 
     def run_install_command(verb, *additional)
-      run(install_command(verb, *additional), stdin: final_values.to_yaml)
+      run(install_command(verb, *additional), stdin: final_values.to_yaml(line_width: -1))
       true
     end
 

data/lib/hippo/repository_tag.rb

@@ -30,8 +30,9 @@ module Hippo
       return nil if @options['url'].nil?
 
       @remote_refs ||= begin
-        puts "Getting remote refs from #{@options['url']}"
-        Git.ls_remote(@options['url'])
+        Util.action "Getting remote refs from #{@options['url']}..." do
+          Git.ls_remote(@options['url'])
+        end
       end
     end
   end

data/lib/hippo/secret_manager.rb

@@ -15,17 +15,7 @@ module Hippo
     CIPHER = OpenSSL::Cipher.new('aes-256-gcm')
 
     def path
-      File.join(@stage.manifest.root, 'secrets', @stage.name + '.yaml')
-    end
-
-    def secret(name)
-      Secret.new(self, name)
-    end
-
-    def secrets
-      Dir[File.join(root, '*.{yml,yaml}')].map do |path|
-        secret(path.split('/').last.sub(/\.ya?ml\z/, ''))
-      end
+      File.join(@stage.config_root, 'secrets.yaml')
     end
 
     # Download the current key from the Kubernetes API and set it as the
@@ -35,13 +25,24 @@ module Hippo
     def download_key
       return if @key
 
-      value = @stage.get('secret', 'hippo-secret-key').first
-      return if value.nil?
-      return if value.dig('data', 'key').nil?
-
-      @key = Base64.decode64(Base64.decode64(value['data']['key']))
-    rescue Hippo::Error => e
-      raise unless e.message =~ /not found/
+      Util.action 'Downloading secret encryiption key...' do |state|
+        begin
+          value = @stage.get('secret', 'hippo-secret-key').first
+
+          if value.nil? || value.dig('data', 'key').nil?
+            state.call('not found')
+            return
+          end
+
+          @key = Base64.decode64(Base64.decode64(value['data']['key']))
+        rescue Hippo::Error => e
+          if e.message =~ /not found/
+            state.call('not found')
+          else
+            raise
+          end
+        end
+      end
     end
 
     # Is there a key availale in this manager?
@@ -118,7 +119,7 @@ module Hippo
 
       return if exists?
 
-      yaml = { 'example' => 'This is an example secret!' }.to_yaml
+      yaml = { 'example' => 'This is an example secret2!' }.to_yaml
       FileUtils.mkdir_p(File.dirname(path))
       File.open(path, 'w') { |f| f.write(encrypt(yaml)) }
     end
@@ -130,9 +131,13 @@ module Hippo
         raise Error, 'Cannot create edit file because no key is available for decryption'
       end
 
-      contents = decrypt(File.read(path))
-      contents = Util.open_in_editor('secret', contents)
-      write_file(contents)
+      old_contents = decrypt(File.read(path))
+      new_contents = Util.open_in_editor('secret', old_contents)
+      if old_contents != new_contents
+        write_file(new_contents)
+      else
+        puts 'No changes detected. Not re-encrypting secret file.'
+      end
     end
 
     def write_file(contents)