Add setBasicAuth method that sets Authorization header. (#26)

* Add setBasicAuth method that sets Authorization header.

Author: Christoffer-Cortes

src/main/java/com/ericsson/eiffelcommons/JenkinsManager.java

@@ -108,7 +108,7 @@ public boolean createJob(String jobName, String jobXmlData) throws Exception {
                    .addHeader("Authorization", "Basic " + encoding)
                    .addHeader("Content-type", MediaType.APPLICATION_XML)
                    .addHeader("Jenkins-Crumb", crumb)
-                   .addParam("name", jobName)
+                   .addParameter("name", jobName)
                    .setBody(jobXmlData)
                    .setEndpoint("/createItem");
 
@@ -306,8 +306,8 @@ public boolean pluginExists(String plugin) throws Exception {
         HttpRequest httpRequest = new HttpRequest(HttpMethod.GET);
         httpRequest.setBaseUrl(jenkinsBaseUrl)
                    .addHeader("Authorization", "Basic " + encoding)
-                   .addParam("depth", "1")
-                   .addParam("wrapper", "plugins")
+                   .addParameter("depth", "1")
+                   .addParameter("wrapper", "plugins")
                    .setEndpoint("/pluginManager/api/json");
 
         ResponseEntity response = httpRequest.performRequest();
@@ -438,7 +438,7 @@ private boolean executeJobTriggering(String jobName, String jobToken, String bui
         httpRequest.setBaseUrl(jenkinsBaseUrl)
                    .addHeader("Authorization", "Basic " + encoding)
                    .addHeader("Content-type", mediatype)
-                   .addParam("token", jobToken)
+                   .addParameter("token", jobToken)
                    .setEndpoint(endpoint);
 
         ResponseEntity response = httpRequest.performRequest();

src/main/java/com/ericsson/eiffelcommons/utils/HttpRequest.java

@@ -18,13 +18,16 @@
 
 import java.io.File;
 import java.io.IOException;
+import java.io.UnsupportedEncodingException;
 import java.net.URI;
 import java.net.URISyntaxException;
 import java.util.HashMap;
 import java.util.Map;
 
+import org.apache.commons.codec.binary.Base64;
 import org.apache.commons.io.FileUtils;
 import org.apache.http.Header;
+import org.apache.http.HttpHeaders;
 import org.apache.http.client.ClientProtocolException;
 import org.apache.http.client.methods.HttpDelete;
 import org.apache.http.client.methods.HttpEntityEnclosingRequestBase;
@@ -81,7 +84,7 @@ public HttpRequest(HttpMethod method, boolean persistentClient) {
     }
 
     private void initExecutor(boolean persistentClient) {
-        if(persistentClient) {
+        if (persistentClient) {
             executor = HttpExecutor.getInstance();
         } else {
             executor = new HttpExecutor();
@@ -90,6 +93,7 @@ private void initExecutor(boolean persistentClient) {
 
     /**
      * Sets the http method for this request object
+     *
      * @param method
      */
     public HttpRequest setHttpMethod(HttpMethod method) {
@@ -113,6 +117,7 @@ public HttpRequest setHttpMethod(HttpMethod method) {
 
     /**
      * Gets the base url(not including endpoint) for example: http://localhost:8080
+     *
      * @return String
      */
     public String getBaseUrl() {
@@ -121,6 +126,7 @@ public String getBaseUrl() {
 
     /**
      * Sets the base url(not including endpoint) for example: http://localhost:8080
+     *
      * @param baseUrl
      */
     public HttpRequest setBaseUrl(String baseUrl) {
@@ -147,18 +153,18 @@ public void resetHttpRequestObject() {
     /**
      * Function the adds a header to the http request.
      *
-     * @param key
-     *            :: the key of the header
-     * @param value
-     *            :: the value of the header
+     * @param key   :: the key of the header
+     * @param value :: the value of the header
      * @return HttpRequest
      */
     public HttpRequest addHeader(String key, String value) {
         request.addHeader(key, value);
         return this;
     }
+
     /**
-     * Function that overwrites the first header with the same name. The new header will be appended to the end of the list, if no header with the given name can be found.
+     * Function that overwrites the first header with the same name. The new header will be appended
+     * to the end of the list, if no header with the given name can be found.
      *
      * @param key
      * @param value
@@ -173,8 +179,7 @@ public HttpRequest setHeader(String key, String value) {
     /**
      * Takes a header key as input and removes that key and value from the list of headers.
      *
-     * @param headerKey
-     *            :: the header to remove
+     * @param headerKey :: the header to remove
      */
     public void removeHeader(String headerKey) {
         request.removeHeaders(headerKey);
@@ -183,34 +188,30 @@ public void removeHeader(String headerKey) {
     /**
      * Function that adds multiple parameters to the http request.
      *
-     * @param parameters
-     *            :: List<NameValuePair>
+     * @param parameters :: List<NameValuePair>
      */
     public void addParameters(Map<String, String> parameters) {
         for (Map.Entry<String, String> entry : parameters.entrySet()) {
-            addParam(entry.getKey(), entry.getValue());
+            addParameter(entry.getKey(), entry.getValue());
         }
     }
 
     /**
      * Function that adds a parameter to the http request.
      *
-     * @param key
-     *            :: the key of the parameter
-     * @param value
-     *            :: the value of the parameter
+     * @param key   :: the key of the parameter
+     * @param value :: the value of the parameter
      * @return HttpRequest
      */
-    public HttpRequest addParam(String key, String value) {
+    public HttpRequest addParameter(String key, String value) {
         params.put(key, value);
         return this;
     }
 
     /**
      * Function that sets the body of the http request with a chosen content type.
      *
-     * @param body
-     *            :: String input
+     * @param body :: String input
      * @return HTTPRequest
      */
     public HttpRequest setBody(String body, ContentType contentType) {
@@ -221,8 +222,7 @@ public HttpRequest setBody(String body, ContentType contentType) {
     /**
      * Function that sets the body of the http request with default content type(text/plain).
      *
-     * @param body
-     *            :: String input
+     * @param body :: String input
      * @return HTTPRequest
      */
     public HttpRequest setBody(String body) {
@@ -231,10 +231,10 @@ public HttpRequest setBody(String body) {
     }
 
     /**
-     * Function that sets the body of the http request with default value of content type (text/plain).
+     * Function that sets the body of the http request with default value of content type
+     * (text/plain).
      *
-     * @param file
-     *            :: File input
+     * @param file :: File input
      * @return HTTPRequest
      * @throws IOException
      */
@@ -246,8 +246,7 @@ public HttpRequest setBody(File file) throws IOException {
     /**
      * Function that sets the body of the http request with a chosen content type.
      *
-     * @param file
-     *            :: File input
+     * @param file :: File input
      * @param type
      * @return HTTPRequest
      * @throws IOException
@@ -257,13 +256,30 @@ public HttpRequest setBody(File file, ContentType contentType) throws IOExceptio
         try {
             fileContent = FileUtils.readFileToString(file, "UTF-8");
         } catch (IOException e) {
-            final String message = "Failed to read the Request body file:" + file.getPath() + ". Message: "
+            final String message = "Failed to read the Request body file:" + file.getPath()
+                    + ". Message: "
                     + e.getMessage();
             throw new IOException(message);
         }
         return setBody(fileContent, contentType);
     }
 
+    /**
+     * Function that sets the Authorization header of the http request.
+     *
+     * @param username
+     * @param password
+     * @return
+     * @throws UnsupportedEncodingException
+     */
+    public HttpRequest setBasicAuth(String username, String password)
+            throws UnsupportedEncodingException {
+        String auth = String.format("%s:%s", username, password);
+        String encodedAuth = new String(Base64.encodeBase64(auth.getBytes()), "UTF-8");
+        params.put(HttpHeaders.AUTHORIZATION, "Basic " + encodedAuth);
+        return this;
+    }
+
     /**
      * Function that executes the http request.
      *
@@ -272,7 +288,8 @@ public HttpRequest setBody(File file, ContentType contentType) throws IOExceptio
      * @throws IOException
      * @throws ClientProtocolException
      */
-    public ResponseEntity performRequest() throws URISyntaxException, ClientProtocolException, IOException {
+    public ResponseEntity performRequest()
+            throws URISyntaxException, ClientProtocolException, IOException {
         URIBuilder builder = createURIBuilder();
         builder = addParametersToURIBuilder(builder);
         request.setURI(builder.build());
@@ -314,7 +331,7 @@ private URIBuilder addParametersToURIBuilder(URIBuilder builder) {
      * @throws URISyntaxException
      */
     private URIBuilder createURIBuilder() throws URISyntaxException {
-        if(endpoint.startsWith("/")) {
+        if (endpoint.startsWith("/")) {
             return new URIBuilder(baseUrl + endpoint);
         } else {
             return new URIBuilder(baseUrl + "/" + endpoint);
@@ -327,7 +344,7 @@ private URIBuilder createURIBuilder() throws URISyntaxException {
      * @return HttpRequest
      */
     private String trimBaseUrl(String baseUrl) {
-        if(baseUrl.endsWith("/")) {
+        if (baseUrl.endsWith("/")) {
             baseUrl = baseUrl.substring(0, baseUrl.length() - 1);
         }
 

src/test/java/com/ericsson/eiffelcommons/Utilstest/HttpRequestTest.java

@@ -2,9 +2,12 @@
 
 import static org.junit.Assert.assertEquals;
 
+import java.io.IOException;
 import java.lang.reflect.InvocationTargetException;
 import java.lang.reflect.Method;
+import java.net.URISyntaxException;
 
+import org.apache.http.client.ClientProtocolException;
 import org.apache.http.client.utils.URIBuilder;
 import org.junit.Test;
 
@@ -13,30 +16,43 @@
 
 public class HttpRequestTest {
     @Test
-    public void testBuildingOfURI() throws NoSuchFieldException, SecurityException, IllegalAccessException, IllegalArgumentException, InvocationTargetException, NoSuchMethodException {
+    public void testBuildingOfURI()
+            throws NoSuchFieldException, SecurityException, IllegalAccessException,
+            IllegalArgumentException, InvocationTargetException, NoSuchMethodException,
+            URISyntaxException, ClientProtocolException, IOException {
         String expectedURI = "http://something.com/testing/test/";
-        HttpRequest request= new HttpRequest(HttpMethod.POST);
-        Method method = request.getClass().getDeclaredMethod("createURIBuilder");
-        method.setAccessible(true);
+        String expectedAuthParam = "Authorization=Basic dXNlcm5hbWU6cGFzc3dvcmQ=";
+        HttpRequest request = new HttpRequest(HttpMethod.POST);
+        Method createURIBuilder = HttpRequest.class.getDeclaredMethod("createURIBuilder");
+        Method addParametersToURIBuilder = HttpRequest.class.getDeclaredMethod(
+                "addParametersToURIBuilder", URIBuilder.class);
+        createURIBuilder.setAccessible(true);
+        addParametersToURIBuilder.setAccessible(true);
 
         request.setBaseUrl("http://something.com");
         request.setEndpoint("/testing/test/");
-        URIBuilder builder = (URIBuilder) method.invoke(request);
+        URIBuilder builder = (URIBuilder) createURIBuilder.invoke(request);
         assertEquals(expectedURI, builder.toString());
 
         request.setBaseUrl("http://something.com/");
         request.setEndpoint("/testing/test/");
-        builder = (URIBuilder) method.invoke(request);
+        builder = (URIBuilder) createURIBuilder.invoke(request);
         assertEquals(expectedURI, builder.toString());
 
         request.setBaseUrl("http://something.com/");
         request.setEndpoint("testing/test/");
-        builder = (URIBuilder) method.invoke(request);
+        builder = (URIBuilder) createURIBuilder.invoke(request);
         assertEquals(expectedURI, builder.toString());
 
         request.setBaseUrl("http://something.com");
         request.setEndpoint("testing/test/");
-        builder = (URIBuilder) method.invoke(request);
+        builder = (URIBuilder) createURIBuilder.invoke(request);
         assertEquals(expectedURI, builder.toString());
+
+        request.setBasicAuth("username", "password");
+        builder = (URIBuilder) createURIBuilder.invoke(request);
+        builder = (URIBuilder) addParametersToURIBuilder.invoke(request, builder);
+        String actualAuthParam = builder.getQueryParams().get(0).toString();
+        assertEquals(expectedAuthParam, actualAuthParam);
     }
 }