hippo-cli 1.1.2 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9340773519ba8065cba065f1e26edd5634df0456c62c5c7367e2e1e557173b1b
-  data.tar.gz: d4e0939fcb6794659b5399a850d9ef76bc02eaad053fb7e32d2701c383480435
+  metadata.gz: f8b14eb5652ec29878ff1d7ccf48685ed7ea0d6c345587e16cd237ebcdf42609
+  data.tar.gz: f180aef6e85fc1cb857dfef0578e2a3a14c3c5e6cc89b3808b07c7e150d8f35d
 SHA512:
-  metadata.gz: 5bdd945ebe90c00af7b70e8f3a776f2a9ded0cf6b5623f3e3612a41d86c42cb805808623226c29b77d88273c2c452459ff52dd80389e2a960a200bcb40de3fef
-  data.tar.gz: 9f2f4b3ed1a7e8823d3fcc476d71c429422396dbbd1b1b8e18662ddec6aed40775b0f3bb015649fbfd16764ac5a9360b212308898ddbb9f5ecc0be854e6ae98b
+  metadata.gz: 26f0e6b8e35bcf6bdb751b00faff8be463d28c36dcff91640e67c90f2c99f9cafccd3c37ceb354170e8f654e1841d9915a06597abc48ad3477de83ada8453942
+  data.tar.gz: be4e0bc1f4180726bee41aece0f947882f9c37006a776107b073dcc6bab0be9525a86c5750e92d119b48622e7a55e91c7713422c4f0def824f9dd8424396025c

data/bin/hippo

@@ -8,7 +8,7 @@ require 'hippo/error'
 require 'hippo/version'
 require 'swamp/cli'
 
-COMMANDS_WITHOUT_STAGE = %w[help init version stages].freeze
+COMMANDS_WITHOUT_STAGE = %w[help init version stages update setup].freeze
 
 begin
   cli = Swamp::CLI.new(:hippo, version: Hippo::VERSION)

data/cli/apply_config.rb

@@ -3,10 +3,6 @@
 command :'apply-config' do
   desc 'Apply configuration'
 
-  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/cli/apply_services.rb

@@ -3,10 +3,6 @@
 command :'apply-services' do
   desc 'Apply service configuration'
 
-  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/cli/console.rb

@@ -3,10 +3,6 @@
 command :console do
   desc 'Open a console based on the configuration'
 
-  option '-h', '--hippofile [RECIPE]', 'The path to the Hippofile (defaults: ./Hippofile)' do |value, options|
-    options[:hippofile] = value.to_s
-  end
-
   option '-d', '--deployment [NAME]', 'The name of the deployment to use' do |value, options|
     options[:deployment] = value.to_s
   end

data/cli/create.rb

@@ -3,10 +3,6 @@
 command :create do
   desc 'Create a new stage'
 
-  option '-h', '--hippofile [RECIPE]', 'The path to the Hippofile (defaults: ./Hippofile)' do |value, options|
-    options[:hippofile] = value.to_s
-  end
-
   option '-n', '--namespace [NAMESPACE]', 'The namespace for the new stage' do |value, options|
     options[:namespace] = value
   end
@@ -21,10 +17,10 @@ command :create do
 
   action do |context|
     require 'hippo/manifest'
-    manifest = Hippo::Manifest.load_from_file(context.options[:hippofile] || './Hippofile')
+    wd = Hippo::WorkingDirectory.new
 
     stage_name = CURRENT_STAGE
-    stage_path = File.join(manifest.root, 'stages', "#{stage_name}.yaml")
+    stage_path = File.join(wd.root, stage_name, 'config.yaml')
 
     if !context.options[:force] && File.file?(stage_path)
       puts "\e[31mA stage named '#{stage_name}' already exists. Use --force to overwrite configuration.\e[0m"
@@ -35,7 +31,7 @@ command :create do
 
     namespace = context.options[:namespace]
     if namespace.nil?
-      namespace = Hippo::Util.ask('Enter a namespace for this stage', default: "#{manifest.name}-#{stage_name}")
+      namespace = Hippo::Util.ask('Enter a namespace for this stage', default: "#{wd.manifest.name}-#{stage_name}")
     end
 
     context_name = context.options[:context]
@@ -49,13 +45,13 @@ command :create do
     yaml['context'] = context_name
 
     require 'hippo/bootstrap_parser'
-    yaml['config'] = Hippo::BootstrapParser.parse(manifest.bootstrap['config'])
+    yaml['config'] = Hippo::BootstrapParser.parse(wd.manifest.bootstrap['config'])
 
     require 'hippo/stage'
-    stage = Hippo::Stage.new(manifest, yaml)
+    stage = Hippo::Stage.new(wd, File.dirname(stage_path), yaml)
 
     require 'hippo/cli'
-    cli = Hippo::CLI.new(manifest, stage)
+    cli = Hippo::CLI.new(wd, stage)
     cli.apply_namespace
 
     if stage.secret_manager.key_available?
@@ -67,11 +63,11 @@ command :create do
 
     FileUtils.mkdir_p(File.dirname(stage_path))
     File.open(stage_path, 'w') { |f| f.write(yaml.to_yaml.sub(/\A---\n/m, '')) }
-    puts "Written new stage file to stages/#{stage.name}.yaml"
+    puts "Written new stage file to #{stage.name}/config.yaml"
 
-    secrets = Hippo::BootstrapParser.parse(manifest.bootstrap['secrets'])
+    secrets = Hippo::BootstrapParser.parse(wd.manifest.bootstrap['secrets'])
     stage.secret_manager.write_file(secrets.to_yaml)
-    puts "Written encrypted secrets into secrets/#{stage.name}.yaml"
+    puts "Written encrypted secrets into #{stage.name}/secrets.yaml"
 
     puts
     puts "\e[32mStage '#{stage.name}' has been created successfully.\e[0m"

data/cli/deploy.rb

@@ -3,10 +3,6 @@
 command :deploy do
   desc 'Deploy the application to Kubernetes (including image build/push)'
 
-  option '-h', '--hippofile [RECIPE]', 'The path to the Hippofile (defaults: ./Hippofile)' do |value, options|
-    options[:hippofile] = value.to_s
-  end
-
   option '--no-jobs', 'Do not run the deploy jobs' do |_value, options|
     options[:jobs] = false
   end

data/cli/install.rb

@@ -3,10 +3,6 @@
 command :install do
   desc 'Run installation jobs for the application'
 
-  option '-h', '--hippofile [RECIPE]', 'The path to the Hippofile (defaults: ./Hippofile)' do |value, options|
-    options[:hippofile] = value.to_s
-  end
-
   option '--no-deploy', 'Do not deploy after install' do |_value, options|
     options[:deploy] = false
   end

data/cli/key.rb

@@ -3,13 +3,10 @@
 command :key do
   desc 'Display/generate details about the secret encryption key'
 
-  option '-h', '--hippofile [RECIPE]', 'The path to the Hippofile (defaults: ./Hippofile)' do |value, options|
-    options[:hippofile] = value.to_s
-  end
-
   option '-g', '--generate', 'Generate a new key' do |_value, options|
     options[:generate] = true
   end
+
   action do |context|
     require 'hippo/cli'
     cli = Hippo::CLI.setup(context)

data/cli/kubectl.rb

@@ -3,10 +3,6 @@
 command :kubectl do
   desc 'Execute kubectl commands with the correct namespace for the 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/cli/logs.rb

@@ -3,10 +3,6 @@
 command :logs do
   desc 'Display logs for a particular pod'
 
-  option '-h', '--hippofile [RECIPE]', 'The path to the Hippofile (defaults: ./Hippofile)' do |value, options|
-    options[:hippofile] = value.to_s
-  end
-
   option '-p', '--pod [POD]', 'The name of the pod' do |value, options|
     options[:pod] = value
   end

data/cli/objects.rb

@@ -3,10 +3,6 @@
 command :objects do
   desc 'Display all objects that will be exported'
 
-  option '-h', '--hippofile [RECIPE]', 'The path to the Hippofile (defaults: ./Hippofile)' do |value, options|
-    options[:hippofile] = value.to_s
-  end
-
   option '-t', '--type [TYPE]', 'Limit which type of object to return (one of config, deployments or services)' do |value, options|
     options[:type] = value
   end

data/cli/package_install.rb

@@ -3,10 +3,6 @@
 command :'package:install' do
   desc 'Install a named helm package'
 
-  option '-h', '--hippofile [RECIPE]', 'The path to the Hippofile (defaults: ./Hippofile)' do |value, options|
-    options[:hippofile] = value.to_s
-  end
-
   option '-p', '--package [NAME]', 'The name of the package to install' do |value, options|
     options[:package] = value
   end

data/cli/package_list.rb

@@ -3,10 +3,6 @@
 command :'package:list' do
   desc 'List all available packages with status'
 
-  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/cli/package_notes.rb

@@ -3,10 +3,6 @@
 command :'package:notes' do
   desc 'Show notes about an installed Helm package'
 
-  option '-h', '--hippofile [RECIPE]', 'The path to the Hippofile (defaults: ./Hippofile)' do |value, options|
-    options[:hippofile] = value.to_s
-  end
-
   option '-p', '--package [NAME]', 'The name of the package to install' do |value, options|
     options[:package] = value
   end

data/cli/package_test.rb

@@ -3,10 +3,6 @@
 command :'package:test' do
   desc 'Test a package installation'
 
-  option '-h', '--hippofile [RECIPE]', 'The path to the Hippofile (defaults: ./Hippofile)' do |value, options|
-    options[:hippofile] = value.to_s
-  end
-
   option '-p', '--package [NAME]', 'The name of the package' do |value, options|
     options[:package] = value
   end

data/cli/package_uninstall.rb

@@ -3,10 +3,6 @@
 command :'package:uninstall' do
   desc 'Uninstall a package'
 
-  option '-h', '--hippofile [RECIPE]', 'The path to the Hippofile (defaults: ./Hippofile)' do |value, options|
-    options[:hippofile] = value.to_s
-  end
-
   option '-p', '--package [NAME]', 'The name of the package' do |value, options|
     options[:package] = value
   end

data/cli/package_upgrade.rb

@@ -3,10 +3,6 @@
 command :'package:upgrade' do
   desc 'Upgrade a package'
 
-  option '-h', '--hippofile [RECIPE]', 'The path to the Hippofile (defaults: ./Hippofile)' do |value, options|
-    options[:hippofile] = value.to_s
-  end
-
   option '-p', '--package [NAME]', 'The name of the package' do |value, options|
     options[:package] = value
   end

data/cli/package_values.rb

@@ -3,10 +3,6 @@
 command :'package:values' do
   desc 'Display the values file that will be used for all packages'
 
-  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/cli/prepare.rb

@@ -3,10 +3,6 @@
 command :prepare do
   desc 'Prepare Kubernetes namespace (including installing all packages)'
 
-  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/cli/readme.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+command :readme do
+  desc 'Display the README'
+
+  action do |context|
+    require 'hippo/cli'
+    cli = Hippo::CLI.setup(context)
+    cli.preflight
+
+    readme = cli.stage.readme
+    raise Error, 'No README is configured for this application' if readme.nil?
+
+    puts '=' * 80
+    puts readme
+    puts '=' * 80
+  end
+end

data/cli/run.rb

@@ -3,10 +3,6 @@
 command :run do
   desc 'Create and run a pod using the given image'
 
-  option '-h', '--hippofile [RECIPE]', 'The path to the Hippofile (defaults: ./Hippofile)' do |value, options|
-    options[:hippofile] = value.to_s
-  end
-
   option '--command [COMMAND]', 'The command to run (defaults to /bin/bash)' do |value, options|
     options[:command] = value.to_s
   end

data/cli/secrets.rb

@@ -3,10 +3,6 @@
 command :secrets do
   desc 'Create/edit an encrypted secrets file'
 
-  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/cli/setup.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+command :setup do
+  desc 'Create a new configuration directory'
+
+  option '--local [PATH]', 'Use a local manifest from the given path' do |value, options|
+    options[:local] = value
+  end
+
+  option '--remote [REPO]', 'Use a repo manifest from the given repository' do |value, options|
+    options[:remote] = value
+  end
+
+  option '-p [PATH]', '--path [PATH]', 'Path within the remote repository' do |value, options|
+    options[:path] = value
+  end
+
+  option '-b [BRANCH]', '--branch [BRANCH]', 'Branch on remote repository' do |value, options|
+    options[:branch] = value
+  end
+
+  action do |context|
+    path = context.args[0]
+    raise Error, 'Provide path as first argument' if path.nil?
+
+    path = File.expand_path(path)
+
+    raise Error, "Directory already exists at #{path}" if File.exist?(path)
+
+    if context.options[:local] && context.options[:remote]
+      raise Error, 'Only specify --local OR --remote'
+    end
+
+    require 'fileutils'
+    FileUtils.mkdir_p(path)
+    source = {}
+    if local_path = context.options[:local]
+      source['type'] = 'local'
+      source['localOptions'] = {
+        'path' => File.expand_path(local_path)
+      }
+    elsif repo = context.options[:remote]
+      source['type'] = 'remote'
+      source['remoteOptions'] = { 'repository' => repo }
+      if context.options[:path]
+        source['remoteOptions']['path'] = context.options[:path]
+      end
+      if context.options[:branch]
+        source['remoteOptions']['branch'] = context.options[:branch]
+      end
+    end
+
+    require 'yaml'
+    config = { 'source' => source }
+    File.open(File.join(path, 'hippo.yaml'), 'w') { |f| f.write(config.to_yaml) }
+    puts "Created configuration directory at #{path}"
+
+    require 'hippo/working_directory'
+    wd = Hippo::WorkingDirectory.new(path)
+    if wd.can_update?
+      puts 'Updating local copy of remote repository...'
+      wd.update_from_remote
+      puts "\e[32mUpdate completed successfully.\e[0m"
+      puts
+      puts "  Repository....: \e[33m#{wd.remote_repository}\e[0m"
+      puts "  Branch........: \e[33m#{wd.remote_branch}\e[0m"
+      puts "  Path..........: \e[33m#{wd.remote_path}\e[0m"
+      puts
+    end
+  end
+end

data/cli/stages.rb

@@ -2,15 +2,12 @@
 
 command :stages do
   desc 'List all stages that are available'
-  option '-h', '--hippofile [RECIPE]', 'The path to the Hippofile (defaults: ./Hippofile)' do |value, options|
-    options[:hippofile] = value.to_s
-  end
 
-  action do |context|
+  action do |_context|
     require 'hippo/manifest'
-    manifest = Hippo::Manifest.load_from_file(context.options[:hippofile] || './Hippofile')
+    wd = Hippo::WorkingDirectory.new
 
-    if manifest.stages.empty?
+    if wd.stages.empty?
       puts 'There are no stages configured yet.'
       puts 'Use the following command to create one:'
       puts
@@ -19,7 +16,7 @@ command :stages do
       exit 0
     end
 
-    manifest.stages.each do |_, stage|
+    wd.stages.each do |_, stage|
       puts "- #{stage.name}"
     end
   end

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)