nexus_cli 0.7.3 → 0.8.0

data/lib/nexus_cli/nexus_remote_factory.rb

@@ -1,11 +1,10 @@
-require 'restclient'
+require 'httpclient'
 require 'nokogiri'
 require 'yaml'
 
 module NexusCli
   class Factory
     class << self
-
       def create(overrides)
         @configuration = Configuration::parse(overrides)
         running_nexus_pro? ? ProRemote.new(overrides) : OSSRemote.new(overrides)
@@ -16,22 +15,41 @@ module NexusCli
       end
 
       def nexus
-        RestClient::Resource.new configuration["url"], :user => configuration["username"], :password => configuration["password"]
+        client = HTTPClient.new
+        # https://github.com/nahi/httpclient/issues/63
+        client.set_auth(nil, configuration['username'], configuration['password'])
+        client.www_auth.basic_auth.challenge(configuration['url'])
+        return client
+      end
+
+      def nexus_url(url)
+        File.join(configuration['url'], url)
       end
 
       def status
-        doc = Nokogiri::XML(nexus['service/local/status'].get).xpath("/status/data")
-        data = Hash.new
-        data['app_name'] = doc.xpath("appName")[0].text
-        data['version'] = doc.xpath("version")[0].text
-        data['edition_long'] = doc.xpath("editionLong")[0].text
-        data['state'] = doc.xpath("state")[0].text
-        data['started_at'] = doc.xpath("startedAt")[0].text
-        data['base_url'] = doc.xpath("baseUrl")[0].text
-        return data
+        response = nexus.get(nexus_url("service/local/status"))
+        case response.status
+        when 200
+          doc = Nokogiri::XML(response.content).xpath("/status/data")
+          data = Hash.new
+          data['app_name'] = doc.xpath("appName")[0].text
+          data['version'] = doc.xpath("version")[0].text
+          data['edition_long'] = doc.xpath("editionLong")[0].text
+          data['state'] = doc.xpath("state")[0].text
+          data['started_at'] = doc.xpath("startedAt")[0].text
+          data['base_url'] = doc.xpath("baseUrl")[0].text
+          return data
+        when 401
+          raise PermissionsException
+        when 503
+          raise CouldNotConnectToNexusException
+        else
+          raise UnexpectedStatusCodeException.new(response.status)
+        end
       end
 
       private
+
       def running_nexus_pro?
         return status['edition_long'] == "Professional" ? true : false
       end

data/lib/nexus_cli/tasks.rb

@@ -11,11 +11,10 @@ module NexusCli
         map 'push'          => :push_artifact
         map 'info'          => :get_artifact_info
         map 'custom'        => :get_artifact_custom_info
-        map 'custom_raw'    => :get_artifact_custom_info_n3
         map 'config'        => :get_nexus_configuration
         map 'status'        => :get_nexus_status
         map 'search'        => :search_for_artifacts
-        map 'search_custom' => :search_artifacts
+        map 'search_custom' => :search_artifacts_custom
 
         class_option :overrides,
           :type => :hash,
@@ -60,13 +59,8 @@ module NexusCli
 
         desc "get_artifact_custom_info artifact", "Gets and returns the custom metadata in XML format about a particular artifact."
         def get_artifact_custom_info(artifact)
-          say @nexus_remote.get_artifact_custom_info(artifact), :green
-        end
-
-        desc "get_artifact_custom_info_n3 artifact", "Gets and returns the custom metadata in Nexus n3 format about a particular artifact."
-        def get_artifact_custom_info_n3(artifact)
           raise NotNexusProException unless @nexus_remote.kind_of? ProRemote
-          say @nexus_remote.get_artifact_custom_info_n3(artifact), :green
+          say @nexus_remote.get_artifact_custom_info(artifact), :green
         end
 
         desc "update_artifact_custom_info artifact param1 param2 ...", "Updates the artifact custom metadata with the given key-value pairs."
@@ -76,13 +70,6 @@ module NexusCli
           say "Custom metadata for artifact #{artifact} has been successfully pushed to Nexus.", :green
         end
 
-        desc "update_artifact_custom_info_n3 artifact file", "Updates the artifact custom metadata by pushing the Nexus custom artifact file (n3) from your machine onto the Nexus."
-        def update_artifact_custom_info_n3(artifact, file)
-          raise NotNexusProException unless @nexus_remote.kind_of? ProRemote
-          @nexus_remote.update_artifact_custom_info_n3(artifact, file)
-          say "Custom metadata for artifact #{artifact} has been successfully pushed to Nexus.", :green
-        end
-
         desc "clear_artifact_custom_info artifact", "Clears the artifact custom metadata."
         def clear_artifact_custom_info(artifact)
           raise NotNexusProException unless @nexus_remote.kind_of? ProRemote
@@ -90,10 +77,10 @@ module NexusCli
           say "Custom metadata for artifact #{artifact} has been successfully cleared.", :green
         end
 
-        desc "search_artifacts param1 param2 ... ", "Searches for artifacts using artifact metadata and returns the result as a list with items in XML format."
-        def search_artifacts(*params)
+        desc "search_artifacts_custom param1 param2 ... ", "Searches for artifacts using artifact metadata and returns the result as a list with items in XML format."
+        def search_artifacts_custom(*params)
           raise NotNexusProException unless @nexus_remote.kind_of? ProRemote
-          say (s = @nexus_remote.search_artifacts(*params)) == "" ? "No search results." : s, :green
+          say (s = @nexus_remote.search_artifacts_custom(*params)) == "" ? "No search results." : s, :green
         end
 
         desc "get_nexus_configuration", "Prints out configuration from the .nexus_cli file that helps inform where artifacts will be uploaded."
@@ -379,6 +366,18 @@ module NexusCli
           @nexus_remote.install_license(license_file)
         end
 
+        desc "get_logging_info", "Gets the log4j Settings of the Nexus server."
+        def get_logging_info
+          say @nexus_remote.get_logging_info, :green
+        end
+
+        desc "set_logger_level level", "Updates the log4j logging level to a new value."
+        def set_logger_level(level)
+          if @nexus_remote.set_logger_level(level)
+            say "The logging level of Nexus has been set to #{level.upcase}", :blue
+          end
+        end
+
         private
 
           def ask_user(params, ask_username=true, ask_password=true)

data/nexus_cli.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   s.add_dependency 'thor'
-  s.add_dependency 'rest-client'
+  s.add_dependency 'httpclient'
   s.add_dependency 'nokogiri'
   s.add_dependency 'extlib'
   s.add_dependency 'json'

data/pro/nexus_custom_metadata.feature

@@ -0,0 +1,97 @@
+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:1.0.0:tgz"
+    Then the output should contain:
+	    """
+	    Artifact com.test:myprotest:1.0.0:tgz 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:1.0.0:tgz somekey:somevalue" command
+		Then the output should contain:
+			"""
+			Custom metadata for artifact com.test:myprotest:1.0.0:tgz 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:1.0.0:tgz somekey:somevalue_1! \"someotherkey:some other value\" tempkey:tempvalue" command
+		Then the output should contain:
+			"""
+			Custom metadata for artifact com.test:myprotest:1.0.0:tgz 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:1.0.0:tgz tempkey:" command
+		Then the output should contain:
+			"""
+			Custom metadata for artifact com.test:myprotest:1.0.0:tgz 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:1.0.0:tgz" 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: Clear an artifact's custom metadata
+		When I call the nexus "clear_artifact_custom_info com.test:myprotest:1.0.0:tgz" command
+		Then the output should contain:
+			"""
+			Custom metadata for artifact com.test:myprotest:1.0.0:tgz 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:1.0.0:tgz"
+    And I call the nexus "info com.test:myprotest:1.0.0:tgz" 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

data/pro/nexus_pro.feature

@@ -10,105 +10,6 @@ Feature: Use the Nexus Pro CLI
 			"""
 		And the exit status should be 0
 
-  @push
-  Scenario: Push an artifact
-    When I push an artifact with the GAV of "com.test:myprotest:1.0.0:tgz"
-    Then the output should contain:
-	    """
-	    Artifact com.test:myprotest:1.0.0:tgz 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:1.0.0:tgz teemoHat:equipped" command
-		Then the output should contain:
-			"""
-			Custom metadata for artifact com.test:myprotest:1.0.0:tgz 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:1.0.0:tgz teemoHat:equipped_ \"teemoSkins:many skins!!1\"" command
-		Then the output should contain:
-			"""
-			Custom metadata for artifact com.test:myprotest:1.0.0:tgz 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:1.0.0:tgz" command
-		Then the output should contain:
-			"""
-			<teemoHat>equipped_</teemoHat>
-			"""
-		And the output should contain:
-			"""
-			<teemoSkins>many skins!!1</teemoSkins>
-			"""
-		And the exit status should be 0
-
-	Scenario: Get an artifact's raw custom metadata
-		When I call the nexus "custom_raw com.test:myprotest:1.0.0:tgz" command
-		Then the output should contain:
-			"""
-			<urn:nexus/user#teemoHat> "equipped_"
-			"""
-		And the output should contain:
-			"""
-			<urn:nexus/user#teemoSkins> "many skins!!1"
-			"""
-		And the exit status should be 0
-
-	Scenario: Search for artifacts by custom metadata using matches
-		When I call the nexus "search_custom teemoHat:matches:equip*" 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 teemoHat:equal:equipped_" 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 teemoHat:matches:equip* teemoHat:equal:equipped_" 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 bestTeemo:equal:malady" command
-		Then the output should contain:
-			"""
-			No search results.
-			"""
-		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:1.0.0:tgz" command
-		Then the output should contain:
-			"""
-			Custom metadata for artifact com.test:myprotest:1.0.0:tgz 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:1.0.0:tgz"
-    And I call the nexus "info com.test:myprotest:1.0.0:tgz" 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
-
   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

data/spec/oss_remote_spec.rb

@@ -12,12 +12,12 @@ describe NexusCli do
   end
   
   it "gives you errors when you attempt to pull an artifact and it cannot be found" do
-    RestClient::Resource.any_instance.stub(:get).and_raise(RestClient::ResourceNotFound)
+    HTTPClient.any_instance.stub(:get).and_raise(NexusCli::ArtifactNotFoundException)
     expect {remote.pull_artifact "com.something:something:1.0.0:tgz", nil}.to raise_error(NexusCli::ArtifactNotFoundException)
   end
 
   it "gives you errors when you attempt to get an artifact's info and it cannot be found" do
-    RestClient::Resource.any_instance.stub(:get).and_raise(RestClient::ResourceNotFound)
+    HTTPClient.any_instance.stub(:get).and_raise(NexusCli::ArtifactNotFoundException)
     expect {remote.get_artifact_info "com.something:something:1.0.0:tgz"}.to raise_error(NexusCli::ArtifactNotFoundException)
   end
 
@@ -27,4 +27,8 @@ describe NexusCli do
          to_return(:status => 404, :body => "", :headers => {})
     expect {remote.update_user(:userId => "qwertyasdf")}.to raise_error(NexusCli::UserNotFoundException)
   end
+
+  it "gives you an error when you try to set the logging level to something weird" do
+    expect {remote.set_logger_level("weird")}.to raise_error(NexusCli::InvalidLoggingLevelException)
+  end
 end

data/spec/pro_remote_spec.rb

@@ -8,7 +8,7 @@ describe NexusCli do
   end
 
   it "gives you errors when you attempt to get an artifact's custom info and it cannot be found" do
-    RestClient::Resource.any_instance.stub(:get).and_raise(RestClient::ResourceNotFound)
+    HTTPClient.any_instance.stub(:get).and_raise(NexusCli::ArtifactNotFoundException)
     expect {remote.get_artifact_custom_info("com.something:something:1.0.0:tgz")}.to raise_error(NexusCli::ArtifactNotFoundException)
   end
 
@@ -21,23 +21,83 @@ describe NexusCli do
   end
 
   it "gives you errors when you attempt to clear an artifact's custom info and it cannot be found" do
-    RestClient::Resource.any_instance.stub(:get).and_raise(RestClient::ResourceNotFound)
+    HTTPClient.any_instance.stub(:get).and_raise(NexusCli::ArtifactNotFoundException)
     expect {remote.clear_artifact_custom_info("com.something:something:1.0.0:tgz")}.to raise_error(NexusCli::ArtifactNotFoundException)
   end
 
   it "gives you errors when you attempt to search for artifacts using custom info and don't give valid key" do
-    expect {remote.search_artifacts("somekey_:equal:somevalue")}.to raise_error(NexusCli::SearchParameterMalformedException)
+    expect {remote.search_artifacts_custom("somekey_:equal:somevalue")}.to raise_error(NexusCli::SearchParameterMalformedException)
   end
 
   it "gives you errors when you attempt to search for artifacts using custom info and don't give valid value" do
-    expect {remote.search_artifacts("somekey:equal:somevalue \"\'\\/")}.to raise_error(NexusCli::SearchParameterMalformedException)
+    expect {remote.search_artifacts_custom("somekey:equal:somevalue \"\'\\/")}.to raise_error(NexusCli::SearchParameterMalformedException)
   end
 
   it "gives you errors when you attempt to search for artifacts using custom info and don't give valid search type" do
-    expect {remote.search_artifacts("somekey:equals:somevalue")}.to raise_error(NexusCli::SearchParameterMalformedException)
+    expect {remote.search_artifacts_custom("somekey:equals:somevalue")}.to raise_error(NexusCli::SearchParameterMalformedException)
   end
 
   it "gives you errors when you attempt to search for artifacts using custom info and don't give valid parameters" do
-    expect {remote.search_artifacts("somekey")}.to raise_error(NexusCli::SearchParameterMalformedException)
+    expect {remote.search_artifacts_custom("somekey")}.to raise_error(NexusCli::SearchParameterMalformedException)
+  end
+
+  describe "tests for custom metadata private helper methods" do
+    it "gives you errors when you attempt to parse custom metadata with bad update keys" do
+      expect {NexusCli::ProRemote.new(nil).send(:parse_custom_metadata_update_params, "goodkey:goodvalue", "badkey_:goodvalue")}.to raise_error(NexusCli::N3ParameterMalformedException)
+    end
+
+    it "gives you errors when you attempt to parse custom metadata with missing update keys" do
+      expect {NexusCli::ProRemote.new(nil).send(:parse_custom_metadata_update_params, ":goodvalue")}.to raise_error(NexusCli::N3ParameterMalformedException)
+    end
+
+    it "gives you errors when you attempt to parse custom metadata with typo" do
+      expect {NexusCli::ProRemote.new(nil).send(:parse_custom_metadata_update_params, "goodkeygoodvalue")}.to raise_error(NexusCli::N3ParameterMalformedException)
+    end
+
+    it "gives you errors when you attempt to parse custom metadata with bad update values" do
+      expect {NexusCli::ProRemote.new(nil).send(:parse_custom_metadata_update_params, "goodkey:goodvalue", "goodkey:badvalue\"'\\")}.to raise_error(NexusCli::N3ParameterMalformedException)
+    end
+
+    it "gives you errors when you attempt to parse custom metadata with missing search type and value" do
+      expect {NexusCli::ProRemote.new(nil).send(:parse_custom_metadata_search_params, "goodkey")}.to raise_error(NexusCli::SearchParameterMalformedException)
+    end
+
+    it "gives you errors when you attempt to parse custom metadata with bad search type" do
+      expect {NexusCli::ProRemote.new(nil).send(:parse_custom_metadata_search_params, "goodkey:eq:goodvalue")}.to raise_error(NexusCli::SearchParameterMalformedException)
+    end
+
+    it "gives you errors when you attempt to parse custom metadata with bad search value" do
+      expect {NexusCli::ProRemote.new(nil).send(:parse_custom_metadata_search_params, "goodkey:equals:badvalue\"'\\")}.to raise_error(NexusCli::SearchParameterMalformedException)
+    end
+  end
+
+  describe "tests for custom metadata private helper methods" do
+    it "gives you errors when you attempt to parse custom metadata with bad update keys" do
+      expect {NexusCli::ProRemote.new(nil).send(:parse_custom_metadata_update_params, "goodkey:goodvalue", "badkey_:goodvalue")}.to raise_error(NexusCli::N3ParameterMalformedException)
+    end
+
+    it "gives you errors when you attempt to parse custom metadata with missing update keys" do
+      expect {NexusCli::ProRemote.new(nil).send(:parse_custom_metadata_update_params, ":goodvalue")}.to raise_error(NexusCli::N3ParameterMalformedException)
+    end
+
+    it "gives you errors when you attempt to parse custom metadata with typo" do
+      expect {NexusCli::ProRemote.new(nil).send(:parse_custom_metadata_update_params, "goodkeygoodvalue")}.to raise_error(NexusCli::N3ParameterMalformedException)
+    end
+
+    it "gives you errors when you attempt to parse custom metadata with bad update values" do
+      expect {NexusCli::ProRemote.new(nil).send(:parse_custom_metadata_update_params, "goodkey:goodvalue", "goodkey:badvalue\"'\\")}.to raise_error(NexusCli::N3ParameterMalformedException)
+    end
+
+    it "gives you errors when you attempt to parse custom metadata with missing search type and value" do
+      expect {NexusCli::ProRemote.new(nil).send(:parse_custom_metadata_search_params, "goodkey")}.to raise_error(NexusCli::SearchParameterMalformedException)
+    end
+
+    it "gives you errors when you attempt to parse custom metadata with bad search type" do
+      expect {NexusCli::ProRemote.new(nil).send(:parse_custom_metadata_search_params, "goodkey:eq:goodvalue")}.to raise_error(NexusCli::SearchParameterMalformedException)
+    end
+
+    it "gives you errors when you attempt to parse custom metadata with bad search value" do
+      expect {NexusCli::ProRemote.new(nil).send(:parse_custom_metadata_search_params, "goodkey:equals:badvalue\"'\\")}.to raise_error(NexusCli::SearchParameterMalformedException)
+    end
   end
 end