nexus_cli_sb 4.0.2

data/features/pro/nexus_custom_metadata.feature

@@ -0,0 +1,116 @@
+Feature: Use the Nexus Pro CLI
+	As a Pro CLI user
+	I need commands to get, update, search, and delete Nexus artifact custom metadata
+
+  Scenario: Push an artifact
+    When I push an artifact with the GAV of "com.test:myprotest:tgz:1.0.0"
+    Then the output should contain:
+	    """
+	    Artifact com.test:myprotest:tgz:1.0.0 has been successfully pushed to Nexus.
+	    """
+    And the exit status should be 0
+
+  Scenario: Update an artifact's custom metadata
+		When I call the nexus "update_artifact_custom_info com.test:myprotest:tgz:1.0.0 somekey:somevalue" command
+		Then the output should contain:
+			"""
+			Custom metadata for artifact com.test:myprotest:tgz:1.0.0 has been successfully pushed to Nexus.
+			"""
+		And the exit status should be 0
+
+	Scenario: Update an artifact's custom metadata with multiple parameters
+		When I call the nexus "update_artifact_custom_info com.test:myprotest:tgz:1.0.0 somekey:somevalue_1! \"someotherkey:some other value\" tempkey:tempvalue" command
+		Then the output should contain:
+			"""
+			Custom metadata for artifact com.test:myprotest:tgz:1.0.0 has been successfully pushed to Nexus.
+			"""
+		And the exit status should be 0
+		
+	Scenario: Update an artifact's custom metadata and remove a key
+		When I call the nexus "update_artifact_custom_info com.test:myprotest:tgz:1.0.0 tempkey:" command
+		Then the output should contain:
+			"""
+			Custom metadata for artifact com.test:myprotest:tgz:1.0.0 has been successfully pushed to Nexus.
+			"""
+		And the exit status should be 0
+
+	Scenario: Get an artifact's custom metadata
+		When I call the nexus "custom com.test:myprotest:tgz:1.0.0" command
+		Then the output should contain:
+			"""
+			<somekey>somevalue_1!</somekey>
+			"""
+		And the output should contain:
+			"""
+			<someotherkey>some other value</someotherkey>
+			"""
+		And the exit status should be 0
+
+	Scenario: Search for artifacts by custom metadata using matches
+		When I call the nexus "search_custom somekey:matches:*value*" command
+		Then the output should contain:
+			"""
+			<artifactId>myprotest</artifactId>
+			"""
+		And the exit status should be 0
+
+	Scenario: Search for artifacts by custom metadata using equal
+		When I call the nexus "search_custom somekey:equal:somevalue_1!" command
+		Then the output should contain:
+			"""
+			<artifactId>myprotest</artifactId>
+			"""
+		And the exit status should be 0
+
+	Scenario: Search for artifacts by custom metadata using multiple parameters
+		When I call the nexus "search_custom somekey:matches:*value* somekey:equal:somevalue_1!" command
+		Then the output should contain:
+			"""
+			<artifactId>myprotest</artifactId>
+			"""
+		And the exit status should be 0
+
+	Scenario: Search for artifacts by custom metadata that return an empty result set
+		When I call the nexus "search_custom fakekey:equal:fakevalue" command
+		Then the output should contain:
+			"""
+			No search results.
+			"""
+		And the exit status should be 0
+
+  Scenario: Transfer an artifact and ensure its metadata is also copied
+    When I call the nexus "transfer com.test:myprotest:tgz:1.0.0 releases thirdparty" command
+    And I call the nexus "custom com.test:myprotest:tgz:1.0.0" command overriding "repository:thirdparty"
+    Then the output should contain:
+      """
+      <somekey>somevalue_1!</somekey>
+      """
+    And the exit status should be 0
+
+	Scenario: Clear an artifact's custom metadata
+		When I call the nexus "clear_artifact_custom_info com.test:myprotest:tgz:1.0.0" command
+		Then the output should contain:
+			"""
+			Custom metadata for artifact com.test:myprotest:tgz:1.0.0 has been successfully cleared.
+			"""
+		And the exit status should be 0
+
+  @delete
+  Scenario: Attempt to delete an artifact
+    When I delete an artifact with the GAV of "com.test:myprotest:tgz:1.0.0"
+    And I call the nexus "info com.test:myprotest:tgz:1.0.0" command
+    Then the output should contain:
+	    """
+	    The artifact you requested information for could not be found. Please ensure it exists inside the Nexus.
+	    """
+    And the exit status should be 101
+
+  @delete
+  Scenario: Attempt to delete another artifact
+    When I delete an artifact with the GAV of "com.test:myprotest:tgz:1.0.0" from the "thirdparty" repository
+    And I call the nexus "info com.test:myprotest:tgz:1.0.0" command overriding "repository:thirdparty"
+    Then the output should contain:
+	    """
+	    The artifact you requested information for could not be found. Please ensure it exists inside the Nexus.
+	    """
+    And the exit status should be 101

data/features/pro/nexus_pro.feature

@@ -0,0 +1,101 @@
+Feature: Use the Nexus Pro CLI
+	As a Pro CLI user
+	I need commands to get, update, search, and delete Nexus artifact custom metadata
+
+	Scenario: Get Nexus Pro Status
+		When I call the nexus "status" command
+		Then the output should contain:
+			"""
+			Application Name: Sonatype Nexus Professional
+			"""
+		And the exit status should be 0
+
+  Scenario: Set a repository to publish updates
+    When I call the nexus "enable_artifact_publish releases" command
+    And I call the nexus "get_pub_sub releases" command
+    Then the output should contain:
+    	"""
+    	<publish>true</publish>
+    	"""
+    And the exit status should be 0
+
+  Scenario: Set a repository to not publish updates
+    When I call the nexus "disable_artifact_publish releases" command
+    And I call the nexus "get_pub_sub releases" command
+    Then the output should contain:
+    	"""
+    	<publish>false</publish>
+    	"""
+    And the exit status should be 0
+
+  Scenario: Set a repository to subscribe to updates
+  	When I call the nexus "enable_artifact_subscribe central" command
+  	And I call the nexus "get_pub_sub central" command
+  	Then the output should contain:
+  		"""
+  		<subscribe>true</subscribe>
+  		"""
+  	And the exit status should be 0
+
+  Scenario: Set a repository to not subscribe to updates
+  	When I call the nexus "disable_artifact_subscribe central" command
+  	And I call the nexus "get_pub_sub central" command
+  	Then the output should contain:
+  		"""
+  		<subscribe>false</subscribe>
+  		"""
+  	And the exit status should be 0
+
+  Scenario: Enable Smart Proxy on the Server
+    When I call the nexus "enable_smart_proxy" command
+    And I call the nexus "get_smart_proxy_settings" command
+    Then the output should contain:
+      """
+      "enabled": true
+      """
+    And the exit status should be 0
+
+  Scenario: Enable Smart Proxy and set the host
+    When I call the nexus "enable_smart_proxy --host=0.0.0.1" command
+    And I call the nexus "get_smart_proxy_settings" command
+    Then the output should contain:
+      """
+      "host": "0.0.0.1"
+      """
+    And the exit status should be 0
+
+  Scenario: Enable Smart Proxy and set the host
+    When I call the nexus "enable_smart_proxy --port=1234" command
+    And I call the nexus "get_smart_proxy_settings" command
+    Then the output should contain:
+      """
+      "port": 1234
+      """
+    And the exit status should be 0
+
+  Scenario: Disable Smart Proxy on the Server
+    When I call the nexus "disable_smart_proxy" command
+    And I call the nexus "get_smart_proxy_settings" command
+    Then the output should contain:
+      """
+      "enabled": false
+      """
+    And the exit status should be 0
+
+  Scenario: Add a trusted key
+    When I add a trusted key to nexus
+    And I call the nexus "get_trusted_keys" command
+    Then the output should contain:
+      """
+      cucumber
+      """
+    And the exit status should be 0
+  
+  Scenario: Delete a trusted key
+    When I delete a trusted key in nexus
+    And I call the nexus "get_trusted_keys" command
+    Then the output should not contain:
+      """
+      cucumber
+      """
+    And the exit status should be 0

data/features/step_definitions/cli_steps.rb

@@ -0,0 +1,105 @@
+require 'aruba/api'
+require 'json'
+require 'jsonpath'
+World(Aruba::Api)
+
+When /^I call the nexus "(.*?)" command$/ do |command|
+  step "I run `nexus-cli #{command} --overrides=#{get_overrides_string}`"
+end
+
+When /^I call the nexus "(.*?)" command overriding "(.*?)"$/ do |command, overrides|
+
+  step "I run `nexus-cli #{command} --overrides=#{create_step_overrides(overrides)}`"
+end
+
+When /^I call the nexus "(.*?)" command as the "(.*?)" user with password "(.*?)"$/ do |command, username, password|
+  overrides = get_overrides_string.gsub('username:admin', "username:#{username}")
+  overrides.gsub!('password:admin123', "password:#{password}")
+  step "I run `nexus-cli #{command} --overrides=#{overrides}`"
+end
+
+When /^I push an artifact with the GAV of "(.*)"$/ do |coordinates|
+  groupId, artifact_id, extension, version = coordinates.split(":")
+  file = File.new(File.join(temp_dir, "#{artifact_id}-#{version}.#{extension}"), 'w')
+  file.puts "some data"
+  file.close
+  step "I run `nexus-cli push #{coordinates} #{file.path} --overrides=#{get_overrides_string}`"
+end
+
+When /^I pull an artifact with the GAV of "(.*?)" to a temp directory$/ do |coordinates|
+  step "I run `nexus-cli pull #{coordinates} --destination #{temp_dir} --overrides=#{get_overrides_string}`"
+end
+
+Then /^I should have a copy of the "(.*?)" artifact in a temp directory$/ do |fileName|
+  File.exists?(File.join(temp_dir, fileName)).should == true
+end
+
+When /^I delete an artifact with the GAV of "(.*)"$/ do |coordinates|
+  nexus_remote.delete_artifact(coordinates)
+end
+
+When /^I delete an artifact with the GAV of "(.*?)" from the "(.*?)" repository$/ do |coordinates, repository|
+  nexus_remote.configuration["repository"] = repository
+  nexus_remote.delete_artifact(coordinates)
+end
+
+When /^I edit the "(.*?)" files "(.*?)" field to true$/ do |file, field|
+  Dir.chdir('tmp/aruba') do
+    json = JSON.parse(File.read(File.join(File.expand_path("~/.nexus"), file)))
+    File.open(File.join(File.expand_path("~/.nexus"), file), "w+") do |opened|
+      json["data"]["globalRestApiSettings"][field] = true
+      opened.write(JSON.pretty_generate(json))
+    end
+  end
+end
+
+When /^I update global settings uiTimeout to (\d+) and upload the json string$/ do |value|  
+  json = JSON.parse(nexus_remote.get_global_settings_json)
+  edited_json = JsonPath.for(json).gsub("$..uiTimeout") {|v| value.to_i}.to_hash
+  nexus_remote.upload_global_settings(JSON.dump(edited_json))
+end
+
+When /^I add a trusted key to nexus$/ do
+  Dir.chdir(temp_dir) do
+    File.open("cert.txt", "w+") do |opened|
+      opened.write("-----BEGIN CERTIFICATE-----
+MIICiTCCAfICCQDIKBRH7YO5mTANBgkqhkiG9w0BAQUFADCBiDELMAkGA1UEBhMC
+VVMxEzARBgNVBAgTCkNhbGlmb3JuaWExFTATBgNVBAcTDFNhbnRhIE1vbmljYTET
+MBEGA1UEChMKUmlvdCBHYW1lczETMBEGA1UEAxMKS3lsZSBBbGxhbjEjMCEGCSqG
+SIb3DQEJARYUa2FsbGFuQHJpb3RnYW1lcy5jb20wHhcNMTIwNjIwMjMxOTQ1WhcN
+MTMwNjIwMjMxOTQ1WjCBiDELMAkGA1UEBhMCVVMxEzARBgNVBAgTCkNhbGlmb3Ju
+aWExFTATBgNVBAcTDFNhbnRhIE1vbmljYTETMBEGA1UEChMKUmlvdCBHYW1lczET
+MBEGA1UEAxMKS3lsZSBBbGxhbjEjMCEGCSqGSIb3DQEJARYUa2FsbGFuQHJpb3Rn
+YW1lcy5jb20wgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAM8Yz96KDxzv7eEt
+DQNLV/3ipXJ5U/lQOQ2BrjSB6qrAHP2u4f+tzJtANXHcRrhXI3oOE993fg82adZg
+XpWLl9wcPHDKP8s5l4TUxMjVJ4UYLJeINwOh/s3cpFq/ni/Klb+QWKG8Vyp6ossF
+VGOc0IiU4ZaC38+jlqvCkHwdCQ4hAgMBAAEwDQYJKoZIhvcNAQEFBQADgYEAG6Eh
+2QO0D69W+9wFvMQAC8YvHNMW9S9A+YRDa5vOeWzUZpeAYuawFSVfjT3fof2ovCU8
+/AR2PyVwJvXRp0Yon2sUfaaFVP4x0BFAwWHk4vLBtqviBhKRdF1D/rR1g4KRowsh
+P5KVneepzhtEt9G/uO4MU89cdUR0IMyUwdhq2dg=
+-----END CERTIFICATE-----
+")
+    end
+    step "I run `nexus-cli add_trusted_key --certificate=#{File.join(temp_dir, "cert.txt")} --description=cucumber --overrides=#{get_overrides_string}`"
+  end
+end
+
+When /^I delete a trusted key in nexus$/ do
+  json = JSON.parse(nexus_remote.get_trusted_keys)
+  key_id = json["data"].first["id"]
+  step "I run `nexus-cli delete_trusted_key #{key_id} --overrides=#{get_overrides_string}`"
+end
+
+Then /^a file named "(.*?)" should exist in my nexus folder$/ do |file|
+  path = File.join(File.expand_path("~/.nexus"), file)
+  step "a file named \"#{path}\" should exist"
+end
+
+Then /^the file "(.*?)" in my nexus folder should contain:$/ do |file, partial_content|
+  path = File.join(File.expand_path("~/.nexus"), file)
+  check_file_content(path, partial_content, true)
+end
+
+Then /^the file "([^"]*)" should contain:$/ do |file, partial_content|
+  check_file_content(file, partial_content, true)
+end

data/features/support/env.rb

@@ -0,0 +1,64 @@
+require 'rubygems'
+require 'bundler'
+require 'spork'
+
+module ArubaOverrides
+  def detect_ruby(cmd)
+    processor, platform, *rest = RUBY_PLATFORM.split("-")
+    if platform =~ /w32$/ && cmd =~ /^nexus-cli /
+      "ruby -I../../lib -S ../../bin/#{cmd}"
+    else
+      "#{cmd}"
+    end
+  end
+end
+
+Spork.prefork do
+  require 'aruba/cucumber'
+  require 'nexus_cli'
+  require 'rspec'
+
+  World(ArubaOverrides)
+
+  Before do
+    @aruba_timeout_seconds = 10
+  end
+
+  def get_overrides_string
+    @overrides_string ||= "url:http://localhost:8081/nexus repository:releases username:admin password:admin123"
+  end
+
+  def get_overrides
+    @overrides ||= {'url' => 'http://localhost:8081/nexus', 'repository' => 'releases', 'username' => 'admin', 'password' => 'admin123'}
+  end
+
+  def create_step_overrides(overrides)
+    overrides_hash = overrides.split(" ").inject({}) do |overrides_hash, override|
+      key, value = override.split(":")
+      overrides_hash[key] = value
+      overrides_hash
+    end
+
+    step_overrides = get_overrides.merge(overrides_hash)
+    step_overrides.to_a.inject("") do |overrides_string, pair|
+      overrides_string << pair.join(":")
+      overrides_string << " "
+    end
+  end
+
+  def temp_dir
+    @tmpdir ||= Dir.mktmpdir
+  end
+
+  def nexus_remote
+    @nexus_remote ||= NexusCli::RemoteFactory.create(get_overrides)
+  end
+
+  at_exit do
+    FileUtils.rm_rf(temp_dir)
+  end
+end
+
+Spork.each_run do
+  require 'nexus_cli'
+end

data/lib/nexus_cli/artifact.rb

@@ -0,0 +1,44 @@
+module NexusCli
+  class Artifact
+    attr_reader :group_id, :artifact_id, :extension, :classifier
+    attr_accessor :version
+
+    # Constructs an artifact object from Maven co-ordinates
+    # See http://maven.apache.org/pom.html#Maven_coordinatess
+    # for more information on maven coordinatess
+    # 
+    # @param  coordinates [String] the Maven identifier
+    # 
+    # @return [Array<String>] an Array with four elements
+    def initialize(coordinates)
+      @group_id, @artifact_id, @extension, @classifier, @version = parse_coordinates(coordinates)
+    end
+
+    def file_name
+      if classifier.nil?
+        "#{artifact_id}-#{version}.#{extension}"
+      else
+        "#{artifact_id}-#{version}-#{classifier}.#{extension}"
+      end
+    end
+
+    private
+
+    def parse_coordinates(coordinates)
+      split_coordinates = coordinates.split(":")
+      if(split_coordinates.size < 3 or split_coordinates.size > 5)
+        raise ArtifactMalformedException
+      end
+
+      group_id = split_coordinates[0]
+      artifact_id = split_coordinates[1]
+      extension = split_coordinates.size > 3 ? split_coordinates[2] : "jar"
+      classifier = split_coordinates.size > 4 ? split_coordinates[3] : nil
+      version = split_coordinates[-1]
+
+      version.upcase! if version == "latest"
+
+      return group_id, artifact_id, extension, classifier, version
+    end
+  end
+end

data/lib/nexus_cli/base_remote.rb

@@ -0,0 +1,16 @@
+module NexusCli
+  class BaseRemote
+    attr_reader :configuration
+    attr_reader :connection
+
+    extend Forwardable
+    def_delegators :@connection, :status, :nexus_url, :nexus, :sanitize_for_id, :running_nexus_pro?
+
+    # @param [Hash] overrides
+    # @param [Boolean] ssl_verify
+    def initialize(overrides, ssl_verify=true)
+      @configuration = overrides ? Configuration.from_overrides(overrides) : Configuration.from_file
+      @connection = Connection.new(configuration, ssl_verify)
+    end
+  end
+end

data/lib/nexus_cli/cli.rb

@@ -0,0 +1,7 @@
+require 'thor'
+
+module NexusCli
+  class Cli < Thor
+    include NexusCli::Tasks
+  end
+end

data/lib/nexus_cli/configuration.rb

@@ -0,0 +1,102 @@
+require 'yaml'
+
+module NexusCli
+  class Configuration
+    DEFAULT_FILE = (ENV['HOME'] ? "~/.nexus_cli" : "/root/.nexus_cli").freeze
+
+    class << self
+      # The filepath to the nexus cli configuration file
+      #
+      # @return [String]
+      def file_path
+        File.expand_path(ENV['NEXUS_CONFIG'] || File.expand_path(DEFAULT_FILE))
+      end
+
+      # Creates a new instance of the Configuration object based on some overrides
+      #
+      # @param [Hash] overrides
+      #
+      # @return [NexusCli::Configuration]
+      def from_overrides(overrides)
+        raise MissingSettingsFileException unless overrides
+        overrides = overrides.with_indifferent_access
+
+        configuration = (load_config || Hash.new).with_indifferent_access
+        configuration.merge!(overrides)
+        new(configuration)
+      end
+
+      # Creates a new instance of the Configuration object from the config file
+      #
+      #
+      # @return [NexusCli::Configuration]
+      def from_file
+        config = load_config
+        raise MissingSettingsFileException unless config
+        config = config.with_indifferent_access
+        new(config)
+      end
+
+      # Validates an instance of the Configuration object and raises when there
+      # is an error with it
+      #
+      # @param  config [NexusCli::Configuration]
+      #
+      # @raise [NexusCli::InvalidSettingsException]
+      def validate!(config)
+        unless config.valid?
+          raise InvalidSettingsException.new(config.errors)
+        end
+      end
+
+      private
+
+        # Loads the config file
+        #
+        # @return [Hash]
+        def load_config
+          begin
+            config = YAML.load_file(file_path)
+          rescue Errno::ENOENT
+            nil
+          end
+        end
+    end
+
+    def validate!
+      self.class.validate!(self)
+    end
+
+    def valid?
+      errors.empty?
+    end
+
+    def errors
+      result = Hash.new
+      result[:url] = ["url required"] unless url.is_a?(String) && url.size > 0
+      result[:repository] = ["repository required"] unless repository.is_a?(String) && repository.size > 0
+      result
+    end
+
+    attr_accessor :url
+    attr_accessor :repository
+    attr_accessor :username
+    attr_accessor :password
+
+    def initialize(options)
+      @url = options[:url]
+      @repository = options[:repository]
+      @username = options[:username]
+      @password = options[:password]
+
+      if @repository.is_a?(String)
+        @repository = @repository.gsub(' ', '_')
+      end
+    end
+
+    def [](attr)
+      self.instance_variable_get('@' + attr.to_s)
+    end
+  end
+end
+

data/lib/nexus_cli/connection.rb

@@ -0,0 +1,84 @@
+module NexusCli
+  class Connection
+    attr_reader :nexus
+    attr_reader :configuration
+    attr_reader :ssl_verify
+
+    def initialize(configuration, ssl_verify)
+      @configuration = configuration
+      @ssl_verify = ssl_verify
+      @nexus = setup_nexus(configuration)
+    end
+
+    # Joins a given url to the current url stored in the configuraiton
+    # and returns the combined String.
+    #
+    # @param [String] url
+    #
+    # @return [String]
+    def nexus_url(url)
+      File.join(configuration['url'], url)
+    end
+
+    # Gets that current status of the Nexus server. On a non-error
+    # status code, returns a Hash of values from the server.
+    #
+    # @return [Hash]
+    def status
+      response = nexus.get(nexus_url("service/local/status"))
+      case response.status
+      when 200
+        doc = REXML::Document.new(response.content).elements["/status/data"]
+        data = Hash.new
+        data['app_name'] = doc.elements["appName"].text
+        data['version'] = doc.elements["version"].text
+        data['edition_long'] = doc.elements["editionLong"].text
+        data['state'] = doc.elements["state"].text
+        data['started_at'] = doc.elements["startedAt"].text
+        data['base_url'] = doc.elements["baseUrl"].text
+        return data
+      when 401
+        raise PermissionsException
+      when 503
+        raise CouldNotConnectToNexusException
+      else
+        raise UnexpectedStatusCodeException.new(response.status)
+      end
+    end
+
+    # Transforms a given [String] into a sanitized version by
+    # replacing spaces with underscores and downcasing.
+    # 
+    # @param  unsanitized_string [String] the String to sanitize
+    # 
+    # @return [String] the sanitized String
+    def sanitize_for_id(unsanitized_string)
+      unsanitized_string.gsub(" ", "_").downcase
+    end
+
+    # Determines whether or not the Nexus server being
+    # connected to is running Nexus Pro.
+    def running_nexus_pro?
+      status['edition_long'] == "Professional"
+    end
+
+    private
+
+    # Returns an HTTPClient instance with settings to connect
+    # to a Nexus server.
+    #
+    # @return [HTTPClient]
+    def setup_nexus(configuration)
+      client = HTTPClient.new
+      client.send_timeout = 6000
+      client.receive_timeout = 6000
+      if configuration['username'] and configuration['password']
+        # https://github.com/nahi/httpclient/issues/63
+        client.set_auth(nil, configuration['username'], configuration['password'])
+        client.www_auth.basic_auth.challenge(configuration['url'])
+      end
+      client.ssl_config.verify_mode = OpenSSL::SSL::VERIFY_NONE unless ssl_verify
+      client
+    end
+  end
+end