morpheus-cli 4.2.14 → 4.2.19

data/lib/morpheus/cli/commands/standard/benchmark_command.rb

@@ -7,11 +7,14 @@ class Morpheus::Cli::BenchmarkCommand
   include Morpheus::Cli::CliCommand
   set_command_name :'benchmark'
 
-  # control global benchmark toggle
-  register_subcommands :on, :off, :on?, :off?
-  # record your own benchmarks
-  register_subcommands :start, :stop, :status, :exec => :execute
-
+  register_subcommand :on, "Enable global benchmarking."
+  register_subcommand :off, "Disable global benchmarking."
+  register_subcommand :on?, "Print the value of the global benchmark setting. Exit 0 if on."
+  register_subcommand :off?, "Print the value of the global benchmark setting. Exit 0 if off."
+  register_subcommand :start, "Start recording a benchmark."
+  register_subcommand :stop, "Stop recording a benchmark."
+  register_subcommand :status, "Print status of benchmark."
+  register_subcommand :exec, :execute, "Benchmark a specified command or expression."
 
   # this would be cool, we should store all benchmarking results in memory or on disk =o
   # register_subcommands :list, :get, :put, :remove
@@ -35,7 +38,7 @@ class Morpheus::Cli::BenchmarkCommand
       opts.banner = subcommand_usage("")
       build_common_options(opts, options, [:quiet])
       opts.footer = <<-EOT
-Enable global benchmarking. 
+#{subcommand_description}
 This behaves the same as if you were to add the -B switch to every command.
 EOT
     end
@@ -65,7 +68,7 @@ EOT
       opts.banner = subcommand_usage("")
       build_common_options(opts, options, [:quiet])
       opts.footer = <<-EOT
-Disable global benchmarking. 
+#{subcommand_description}
 The default state for this setting is off.
 EOT
     end
@@ -95,7 +98,7 @@ EOT
       opts.banner = subcommand_usage("")
       build_common_options(opts, options, [:quiet])
       opts.footer = <<-EOT
-Print the value of the global benchmark setting. 
+#{subcommand_description}
 Exit 0 if on.
 EOT
     end
@@ -121,7 +124,7 @@ EOT
       opts.banner = subcommand_usage("")
       build_common_options(opts, options, [:quiet])
       opts.footer = <<-EOT
-Print the value of the global benchmark setting. 
+#{subcommand_description}
 Exit 0 if off.
 EOT
     end
@@ -149,7 +152,7 @@ EOT
       opts.banner = subcommand_usage("[name]")
       build_common_options(opts, options, [:quiet])
       opts.footer = <<-EOT
-Start recording a benchmark.
+#{subcommand_description}
 [name] is required. This is just a name for the routine.
 This allows you to record how long it takes to run a series of commands.
 Just run `benchmark stop` when you are finished.
@@ -194,7 +197,7 @@ EOT
       end
       build_common_options(opts, options, [:quiet])
       opts.footer = <<-EOT
-Stop recording a benchmark.
+#{subcommand_description}
 [name] is optional. This is the name of the benchmark to stop. 
 The last benchmark is used by default.
 EOT
@@ -254,7 +257,7 @@ EOT
       opts.banner = subcommand_usage("[name]")
       build_common_options(opts, options, [:quiet])
       opts.footer = <<-EOT
-Print status of benchmark.
+#{subcommand_description}
 [name] is optional. This is the name of the benchmark to inspect.
 The last benchmark is used by default.
 EOT
@@ -309,7 +312,7 @@ EOT
       end
       build_common_options(opts, options, [:quiet])
       opts.footer = <<-EOT
-Benchmark a specified command.
+#{subcommand_description}
 [command] is required. This is the command to execute
 EOT
     end
@@ -360,7 +363,7 @@ EOT
         else
           out << "\texit: 0 "
         end
-        total_time_str = "#{benchmark_record.duration.round((benchmark_record.duration > 0.002) ? 3 : 6)}s"
+        total_time_str = "#{benchmark_record.duration.round((benchmark_record.duration > 0.002) ? 3 : 6)} s"
         out << "\t #{total_time_str.ljust(9, ' ')}"
       else
         benchmark_records = []
@@ -381,8 +384,8 @@ EOT
         # all_durations = benchmark_records.collect {|benchmark_record| benchmark_record.duration }
         # total_duration = all_durations.inject(0.0) {|acc, i| acc + i }
         # avg_duration = total_duration / all_durations.size
-        # total_time_str = "#{total_duration.round((total_duration > 0.002) ? 3 : 6)}s"
-        # avg_time_str = "#{avg_duration.round((total_duration > 0.002) ? 3 : 6)}s"
+        # total_time_str = "#{total_duration.round((total_duration > 0.002) ? 3 : 6)} s"
+        # avg_time_str = "#{avg_duration.round((total_duration > 0.002) ? 3 : 6)} s"
 
         all_durations = []
         stats = {total: 0, avg: nil, min: nil, max: nil}
@@ -403,10 +406,10 @@ EOT
           stats[:avg] = stats[:total].to_f / all_durations.size
         end
 
-        total_time_str = "#{stats[:total].round((stats[:total] > 0.002) ? 3 : 6)}s"
-        min_time_str = stats[:min] ? "#{stats[:min].round((stats[:min] > 0.002) ? 3 : 6)}s" : ""
-        max_time_str = stats[:max] ? "#{stats[:max].round((stats[:max] > 0.002) ? 3 : 6)}s" : ""
-        avg_time_str = stats[:avg] ? "#{stats[:avg].round((stats[:avg] > 0.002) ? 3 : 6)}s" : ""
+        total_time_str = "#{stats[:total].round((stats[:total] > 0.002) ? 3 : 6)} s"
+        min_time_str = stats[:min] ? "#{stats[:min].round((stats[:min] > 0.002) ? 3 : 6)} s" : ""
+        max_time_str = stats[:max] ? "#{stats[:max].round((stats[:max] > 0.002) ? 3 : 6)} s" : ""
+        avg_time_str = stats[:avg] ? "#{stats[:avg].round((stats[:avg] > 0.002) ? 3 : 6)} s" : ""
 
         out = ""
         # <benchmark name or command>

data/lib/morpheus/cli/commands/standard/man_command.rb

@@ -176,7 +176,7 @@ morpheus v#{Morpheus::Cli::VERSION}
 
     To learn more about the Morpheus Appliance, visit https://www.morpheusdata.com/features
 
-    To learn more about the Morpheus API, visit http://bertramdev.github.io/morpheus-apidoc/ 
+    To learn more about the Morpheus API, visit https://apidocs.morpheusdata.com
 
 ## GLOBAL OPTIONS
 

data/lib/morpheus/cli/credentials.rb

@@ -87,7 +87,7 @@ module Morpheus
           rescue ::RestClient::Exception => e
             #raise e
             print_red_alert "Token not valid."
-            if options[:debug] || options[:debug]
+            if options[:debug]
               print_rest_exception(e, options)
             end
             wallet = nil
@@ -255,8 +255,7 @@ module Morpheus
         true
       end
 
-      def use_refresh_token(options = {})
-        #puts "use_refresh_token(#{options})"
+      def use_refresh_token(refresh_token_value, options = {})
         
         wallet = load_saved_credentials
 
@@ -265,22 +264,25 @@ module Morpheus
           return nil
         end
 
-        if wallet['refresh_token'].nil?
-          print_red_alert yellow,"No refresh token found for #{display_appliance(@appliance_name, @appliance_url)}",reset,"\n"
-          return nil
+        if refresh_token_value.nil?
+          if wallet['refresh_token']
+            refresh_token_value = wallet['refresh_token']
+          else
+            print_red_alert yellow,"No refresh token found for #{display_appliance(@appliance_name, @appliance_url)}",reset,"\n"
+            return nil
+          end
         end
 
-
         username = wallet['username']
 
         begin
           auth_interface = Morpheus::AuthInterface.new({url:@appliance_url})
           auth_interface.setopts(options)
           if options[:dry_run]
-            print_dry_run auth_interface.dry.use_refresh_token(wallet['refresh_token'])
+            print_dry_run auth_interface.dry.use_refresh_token(refresh_token_value)
             return nil
           end
-          json_response = auth_interface.use_refresh_token(wallet['refresh_token'])
+          json_response = auth_interface.use_refresh_token(refresh_token_value)
           #wallet = json_response
           login_date = Time.now
           expire_date = nil
@@ -311,6 +313,8 @@ module Morpheus
             print_rest_exception(e, options)
           end
           wallet = nil
+          # return now or else it will log them out
+          return nil
         end
 
         # save wallet to credentials file

data/lib/morpheus/cli/deploy.rb

@@ -0,0 +1,374 @@
+require 'morpheus/cli/cli_command'
+require 'yaml'
+
+class Morpheus::Cli::Deploy
+  include Morpheus::Cli::CliCommand
+  include Morpheus::Cli::DeploymentsHelper
+
+  set_command_name :deploy
+
+  def connect(opts)
+    @api_client = establish_remote_appliance_connection(opts)
+    @instances_interface = @api_client.instances
+    @deploy_interface = @api_client.deploy
+    @deployments_interface = @api_client.deployments
+  end
+
+  def handle(args)
+    options={}
+    optparse = Morpheus::Cli::OptionParser.new do|opts|
+      opts.banner = "Usage: morpheus deploy [environment]"
+      build_common_options(opts, options, [:auto_confirm, :remote, :dry_run])
+      opts.footer = <<-EOT
+Deploy to an instance using the morpheus.yml file, located in the working directory.
+[environment] is optional. Merge settings under environments.{environment}. Default is no environment.
+
+First this parses the morpheus.yml file and merges the specified environment settings.
+The specified instance must exist and the specified version must not exist.
+If the settings are valid, the new deployment version will be created and 
+all the specified files are uploaded to the new deployment version.
+Finally, it deploys the new version to the instance.
+
+The morpheus.yml should be located in the working directory.
+This file contains the information necessary to perform a deployment via the cli.
+
+File Settings
+==================
+
+* name - (required) The instance name we are deploying to and, by default, name of the deployment being created.
+* version - (required) The version identifier of the deployment being created (userVersion)
+* deployment - The name of the deployment being created, name is used by default
+* script - The initial script to run before looking for files to upload.
+* files - List of file patterns to use for uploading files and their target destination. 
+          Each item should contain path and pattern, path may be relative to the working directory, default pattern is: '**/*'
+* options - Map of deployment options depending on deployment type
+* post_script - A post operation script to be run on the local machine
+* stage_only - If set to true the deploy will only be staged and not actually run
+* environments - Map of objects that contain nested properties for each environment name
+
+It is possible to nest these properties in an "environments" map to override based on a passed environment.
+
+Example
+==================
+
+name: neatsite
+version: 5.0
+script: "rake build"
+files: 
+- path: build
+environments:
+  production:
+    files:
+    - path: production-build
+EOT
+    end
+    optparse.parse!(args)
+    verify_args!(args:args, optparse:optparse, min:0, max:1)
+    options[:options]['name'] = args[0] if args[0]
+    connect(options)
+    payload = {}
+    
+    environment = default_deploy_environment
+    if args.count > 0
+      environment = args[0]
+    end
+    if load_deploy_file().nil?
+      raise_command_error "Morpheus Deploy File `morpheus.yml` not detected. Please create one and try again."
+    end
+
+    # Parse and validate config, need instance + deployment + version + files
+    # name can be specified as a single value for both instance and deployment
+
+    deploy_args = merged_deploy_args(environment)
+
+    instance_name = deploy_args['name']
+    if deploy_args['instance'].is_a?(String)
+      instance_name = deploy_args['instance']
+    end
+    if instance_name.nil?
+      raise_command_error "Instance not specified. Please specify the instance name and try again."
+    end
+
+    deployment_name = deploy_args['name'] || instance_name
+    if deploy_args['deployment'].is_a?(String)
+      deployment_name = deploy_args['deployment']
+    end
+    
+    version_number = deploy_args['version']
+    if version_number.nil?
+      raise_command_error "Version not specified. Please specify the version and try again."
+    end
+
+    instance_results = @instances_interface.list(name: instance_name)
+    if instance_results['instances'].empty?
+      raise_command_error "Instance not found by name '#{instance_name}'"
+    end
+    instance = instance_results['instances'][0]
+    instance_id = instance['id']
+
+    # ok do it
+    # fetch/create deployment, create deployment version, upload files, and deploy it to instance.
+
+    print_h1 "Morpheus Deployment"
+
+    columns = {
+      "Instance" => :name,
+      "Deployment" => :deployment,
+      "Version" => :version,
+      "Script" => :script,
+      "Post Script" => :post_script,
+      "Files" => :files,
+      "Environment" => :environment,
+    }
+    pretty_file_config = deploy_args['files'].collect {|it|
+      [(it['path'] ? "path: #{it['path']}" : nil), (it['pattern'] ? "pattern: #{it['pattern']}" : nil)].compact.join(", ")
+    }.join(", ")
+    deploy_settings = {
+      :name => instance_name,
+      :deployment => deployment_name,
+      :version => version_number,
+      :script => deploy_args['script'],
+      :post_script => deploy_args['post_script'],
+      :files => pretty_file_config,
+      # :files => deploy_args['files'],
+      # :files => deploy_files.size,
+      # :file_config => (deploy_files.size == 1 ? deploy_files[0][:destination] : deploy_args['files'])
+      :environment => environment
+    }
+    columns.delete("Script") if deploy_settings[:script].nil?
+    columns.delete("Post Script") if deploy_settings[:post_script].nil?
+    columns.delete("Environment") if deploy_settings[:environment].nil?
+    print_description_list(columns, deploy_settings)
+    print reset, "\n"
+
+    if !deploy_args['script'].nil?
+      # do this for dry run too since this is usually what creates the files to be uploaded
+      print cyan, "Executing Pre Deploy Script...", reset, "\n"
+      puts "running command: #{deploy_args['script']}"
+      if !system(deploy_args['script'])
+        raise_command_error "Error executing pre script..."
+      end
+    end
+
+    # Find Files to Upload
+    deploy_files = []
+    if deploy_args['files'].nil? || deploy_args['files'].empty? || !deploy_args['files'].is_a?(Array)
+      raise_command_error "Files not specified. Please specify files array, each item may specify a path or pattern of file(s) to upload"
+    else
+      #print "\n",cyan, "Finding Files...", reset, "\n"
+      current_working_dir = Dir.pwd
+      deploy_args['files'].each do |fmap|
+        Dir.chdir(fmap['path'] || current_working_dir)
+        files = Dir.glob(fmap['pattern'] || '**/*')
+        files.each do |file|
+          if File.file?(file)
+            destination = file.split("/")[0..-2].join("/")
+            # deploy_files << {filepath: File.expand_path(file), destination: destination}
+            deploy_files << {filepath: File.expand_path(file), destination: file}
+          end
+        end
+      end
+      #print cyan, "Found #{deploy_files.size} Files to Upload!", reset, "\n"
+      Dir.chdir(current_working_dir)
+    end
+
+    if deploy_files.empty?
+      raise_command_error "0 files found for: #{deploy_args['files'].inspect}"
+    else
+      print cyan, "Found #{deploy_files.size} Files to Upload!", reset, "\n"
+    end
+
+    unless options[:yes] || Morpheus::Cli::OptionTypes.confirm("Are you sure you want to create deployment version #{version_number} (#{deploy_files.size} #{deploy_files.size == 1 ? 'file' : 'files'}) and deploy it to instance #{instance['name']}?")
+      return 9, "aborted command"
+    end
+    
+    # Find or Create Deployment
+    deployment = nil
+    deployments = @deployments_interface.list(name: deployment_name)['deployments']
+
+    @instances_interface.setopts(options)
+    @deploy_interface.setopts(options)
+    @deployments_interface.setopts(options)
+
+    if deployments.size > 1
+      raise_command_error "#{deployments.size} deployment versions found by deployment '#{name}'"
+    elsif deployments.size == 1
+      deployment = deployments[0]
+      # should update here, eg description
+    else
+      # create it
+      payload = {
+        'deployment' => {
+          'name' => deployment_name
+        } 
+      }
+      payload['deployment']['description'] = deploy_args['description'] if deploy_args['description']
+      
+      if options[:dry_run]
+        print_dry_run @deployments_interface.dry.create(payload)
+        # return 0, nil
+        deployment = {'id' => ':deploymentId', 'name' => deployment_name}
+      else
+        json_response = @deployments_interface.create(payload)
+        deployment = json_response['deployment']
+      end
+    end
+
+    # Find or Create Deployment Version
+    # Actually, for now this this errors if the version already exists, but it should update it.
+
+    @deployments_interface = @api_client.deployments
+    deployment_version = nil
+    if options[:dry_run]
+      print_dry_run @deployments_interface.dry.list_versions(deployment['id'], {userVersion: version_number})
+      # return 0, nil
+      #deployment_versions =[{'id' => ':versionId', 'version' => version_number}]
+      deployment_versions = []
+    else
+      deployment_versions = @deployments_interface.list_versions(deployment['id'], {userVersion: version_number})['versions']
+      @deployments_interface.setopts(options)
+    end
+    
+
+    if deployment_versions.size > 0
+      raise_command_error "Deployment '#{deployment['name']}' version '#{version_number}' already exists. Specify a new version or delete the existing version."
+    # if deployment_versions.size > 1
+    #   raise_command_error "#{deployment_versions.size} versions found by version '#{name}'"
+    # elsif deployment_versions.size == 1
+    #   deployment_version = deployment_versions[0]
+    #   # should update here, eg description
+    else
+      # create it
+      payload = {
+        'version' => {
+          'userVersion' => version_number,
+          'deployType' => (deploy_args['type'] || deploy_args['deployType'] || 'file')
+        } 
+      }
+      payload['version']['fetchUrl'] = deploy_args['fetchUrl'] if deploy_args['fetchUrl']
+      payload['version']['gitUrl'] = deploy_args['gitUrl'] if deploy_args['gitUrl']
+      payload['version']['gitRef'] = deploy_args['gitRef'] if deploy_args['gitRef']
+      
+      if options[:dry_run]
+        print_dry_run @deployments_interface.dry.create_version(deployment['id'], payload)
+        # return 0, nil
+        deployment_version = {'id' => ':versionId', 'version' => version_number}
+      else
+        json_response = @deployments_interface.create_version(deployment['id'], payload)
+        deployment_version = json_response['version']
+      end
+    end
+
+    
+    # Upload Files
+    if deploy_files && !deploy_files.empty?
+      print "\n",cyan, "Uploading #{deploy_files.size} Files...", reset, "\n"
+      current_working_dir = Dir.pwd
+      deploy_files.each do |f|
+        destination = f[:destination]
+        if options[:dry_run]
+          print_dry_run @deployments_interface.upload_file(deployment['id'], deployment_version['id'], f[:filepath], f[:destination])
+        else
+          print cyan,"  - Uploading #{f[:destination]} ...", reset if !options[:quiet]
+          upload_result = @deployments_interface.upload_file(deployment['id'], deployment_version['id'], f[:filepath], f[:destination])
+          #print green + "SUCCESS" + reset + "\n" if !options[:quiet]
+          print reset, "\n" if !options[:quiet]
+        end
+      end
+      print cyan, "Upload Complete!", reset, "\n"
+      Dir.chdir(current_working_dir)
+    else
+      print "\n",cyan, "0 files to upload", reset, "\n"
+    end
+
+    # TODO: support deploying other deployTypes too, git and fetch
+
+    if !deploy_args['post_script'].nil?
+      print cyan, "Executing Post Script...", reset, "\n"
+      puts "running command: #{deploy_args['post_script']}"
+      if !system(deploy_args['post_script'])
+        raise_command_error "Error executing post script..."
+      end
+    end
+
+    # JD: restart for evars eh?
+    if deploy_args['env']
+      evars = []
+      deploy_args['env'].each_pair do |key, value|
+        evars << {name: key, value: value, export: false}
+      end
+      payload = {envs: evars}
+      if options[:dry_run]
+        print_dry_run @instances_interface.dry.create_env(instance_id, payload)
+        print_dry_run @instances_interface.dry.restart(instance_id)
+      else
+        @instances_interface.create_env(instance_id, payload)
+        @instances_interface.restart(instance_id)
+      end
+    end
+    # Create the AppDeploy, this does the deploy async (as of 4.2.2-3)
+    payload = {'appDeploy' => {} }
+    payload['appDeploy']['versionId'] = deployment_version['id']
+    if deploy_args['options']
+      payload['appDeploy']['config'] = deploy_args['options']
+    end
+    # stageOnly means do not actually deploy yet, can invoke @deploy_interface.deploy(deployment['id']) later
+    # there is no cli command for that yet though..
+    stage_only = deploy_args['stage_deploy'] || deploy_args['stage_only'] || deploy_args['stageOnly']
+    if stage_only
+      payload['appDeploy']['stageOnly'] = true
+    end
+    app_deploy_id = nil
+    if options[:dry_run]
+      print_dry_run @deploy_interface.dry.create(instance_id, payload)
+      # return 0, nil
+      app_deploy_id = ':appDeployId'
+    else
+      # Create a new appDeploy record, without stageOnly, this actually does the deployment
+      print cyan, "Deploying #{deployment_name} version #{version_number} to instance #{instance_name} ...", reset, "\n"
+      deploy_result = @deploy_interface.create(instance_id, payload)
+      app_deploy = deploy_result['appDeploy']
+      app_deploy_id = app_deploy['id']
+      print_green_success "Deploy Successful!"
+    end
+    return 0, nil
+  end
+
+  protected
+
+  # Loads a morpheus.yml file from within the current working directory.
+  # This file contains information necessary to perform a deployment via the cli.
+  #
+  # === Example File Attributes
+  # * +script+ - The initial script to run before uploading files
+  # * +name+ - The instance name we are deploying to (can be overridden in CLI)
+  # * +files+ - List of file patterns to use for uploading files and their target destination
+  # * +options+ - Map of deployment options depending on deployment type
+  # * +post_script+ - A post operation script to be run on the local machine
+  # * +stage_deploy+ - If set to true the deploy will only be staged and not actually run
+  #
+  # +NOTE: + It is also possible to nest these properties in an "environments" map to override based on a passed environment deploy name
+  #
+  def load_deploy_file
+    if !File.exist? "morpheus.yml"
+      puts "No morpheus.yml file detected in the current directory. Nothing to do."
+      return nil
+    end
+
+    @deploy_file = YAML.load_file("morpheus.yml")
+    return @deploy_file
+  end
+
+  def merged_deploy_args(environment)
+    deploy_args = @deploy_file.reject { |key,value| key == 'environment'}
+    if environment && !@deploy_file['environment'].nil? && !@deploy_file['environment'][environment].nil?
+      deploy_args = deploy_args.merge(@deploy_file['environment'][environment])
+    end
+    return deploy_args
+  end
+
+  def default_deploy_environment
+    nil
+  end
+
+end