Feature/v6.0.2 (#83)

* Updated Api version to `7.2`

* Initial commit

* Updated Api versions

* Added code coverage Api

* Added code coverage Api tests

* Rename json response property name

* Rename json response property name

* Initial commit

* Added support for test iterations API

* Test session Api initial commit

* Test suites Api initial commit

* Added Test suites Api

* Minor update

* Minor update

* Added Test suites API version

* Added Test history API version

* Initial commit

* Added test cases and history APIs

* Test points API initial commit

* Added Test points API version

* Added Test points API

* Minor changes

* Bumped version to `v6.0.2`

* Updated tests

* Added helper methods

* Initial commit

* Update to query parameters

* Updated Api version

Author: hkarthik7

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+# 6.0.2
+
+- Added support for Test suites, results, points, cases and history APIs.
+
 # 6.0.1
 
 - Added support for TestCaseResult in **TestApi**.

README.md

@@ -3,7 +3,7 @@
 [![Build Status](https://dev.azure.com/harishkarthic/azure-devops-java-sdk/_apis/build/status/hkarthik7.azure-devops-java-sdk?branchName=main)](https://dev.azure.com/harishkarthic/azure-devops-java-sdk/_build/latest?definitionId=8&branchName=main)
 [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/hkarthik7/azure-devops-java-sdk/blob/main/LICENSE)
 [![Documentation Status](https://readthedocs.org/projects/azure-devops-java-sdk-docs/badge/?version=latest)](https://azure-devops-java-sdk-docs.readthedocs.io/en/latest/?badge=latest)
-[![Maven Central](https://img.shields.io/maven-central/v/io.github.hkarthik7/azd.svg)](https://search.maven.org/artifact/io.github.hkarthik7/azd/6.0.1/jar)
+[![Maven Central](https://img.shields.io/maven-central/v/io.github.hkarthik7/azd.svg)](https://search.maven.org/artifact/io.github.hkarthik7/azd/6.0.2/jar)
 
 **azd** library provides a convenient way to manage and interact with **Azure DevOps Services** REST API with ease. This SDK offers a set of APIs and utilities
 with declarative syntax and provide functionalities to the significant services.
@@ -33,7 +33,7 @@ To download the library and use it in your project, just add below in your pom.x
 <dependency>
   <groupId>io.github.hkarthik7</groupId>
   <artifactId>azd</artifactId>
-  <version>6.0.1</version>
+  <version>6.0.2</version>
 </dependency>
 ```
 
@@ -43,7 +43,7 @@ To download the library and use it in your project, just add below in your pom.x
 <dependency>
     <groupId>io.github.hkarthik7</groupId>
     <artifactId>azd</artifactId>
-    <version>6.0.1</version>
+    <version>6.0.2</version>
     <classifier>javadoc</classifier>
 </dependency>
 ```
@@ -54,7 +54,7 @@ To download the library and use it in your project, just add below in your pom.x
 <dependency>
     <groupId>io.github.hkarthik7</groupId>
     <artifactId>azd</artifactId>
-    <version>6.0.1</version>
+    <version>6.0.2</version>
     <classifier>sources</classifier>
 </dependency>
 ```

azd/pom.xml

@@ -6,7 +6,7 @@
 
     <groupId>io.github.hkarthik7</groupId>
     <artifactId>azd</artifactId>
-    <version>6.0.1</version>
+    <version>6.0.2</version>
     <packaging>jar</packaging>
 
     <name>azd</name>

azd/src/main/java/org/azd/common/ApiVersion.java

@@ -55,7 +55,12 @@ public abstract class ApiVersion {
     public static final String TEST_RUNS = "7.2-preview.3";
     public static final String TEST_ITERATIONS = "7.2-preview.3";
     public static final String TEST_CODE_COVERAGE = "7.2-preview.1";
+    public static final String TEST_SESSION = "7.2-preview.1";
     public static final String TEST_RESULTS = "7.2-preview.6";
+    public static final String TEST_CASES = "7.2-preview.1";
+    public static final String TEST_HISTORY = "7.2-preview.2";
+    public static final String TEST_SUITES = "7.2-preview.3";
+    public static final String TEST_POINTS = "7.2-preview.2";
     public static final String VARIABLE_GROUPS = "7.2-preview.2";
     public static final String WIKI = "7.2-preview.2";
     public static final String WIKI_ATTACHMENTS = "7.2-preview.1";

azd/src/main/java/org/azd/enums/TestSessionSource.java

@@ -0,0 +1,52 @@
+package org.azd.enums;
+
+import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
+import com.fasterxml.jackson.annotation.JsonProperty;
+
+/**
+ * Source of the test session
+ */
+@JsonIgnoreProperties(ignoreUnknown = true)
+public enum TestSessionSource {
+    /**
+     * The session was created from feedback client.
+     */
+    @JsonProperty("feedbackDesktop")
+    FEEDBACK_DESKTOP,
+
+    /**
+     * The session was created from browser extension.
+     */
+    @JsonProperty("feedbackWeb")
+    FEEDBACK_WEB,
+
+    /**
+     * To show sessions from all supported sources.
+     */
+    @JsonProperty("sessionInsightsForAll")
+    SESSION_IN_SIGHTS_FOR_ALL,
+
+    /**
+     * Source of test session uncertain as it is stale
+     */
+    @JsonProperty("unknown")
+    UNKNOWN,
+
+    /**
+     * The session was created from Microsoft Test Manager exploratory desktop tool.
+     */
+    @JsonProperty("xtDesktop")
+    XT_DESKTOP,
+
+    /**
+     * The session was created from web access using Microsoft Test Manager exploratory desktop tool.
+     */
+    @JsonProperty("xtDesktop2")
+    XT_DESKTOP2,
+
+    /**
+     * The session was created from browser extension.
+     */
+    @JsonProperty("xtWeb")
+    XT_WEB,
+}

azd/src/main/java/org/azd/enums/TestSessionState.java

@@ -0,0 +1,47 @@
+package org.azd.enums;
+
+import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
+import com.fasterxml.jackson.annotation.JsonProperty;
+
+/**
+ * State of the test session
+ */
+@JsonIgnoreProperties(ignoreUnknown = true)
+public enum TestSessionState {
+
+    /**
+     * The session has completed.
+     */
+    @JsonProperty("completed")
+    COMPLETED,
+
+    /**
+     * This is required for Feedback session which are declined
+     */
+    @JsonProperty("declined")
+    DECLINED,
+
+    /**
+     * The session is running.
+     */
+    @JsonProperty("inProgress")
+    IN_PROGRESS,
+
+    /**
+     * The session is still being created.
+     */
+    @JsonProperty("notStarted")
+    NOT_STARTED,
+
+    /**
+     * The session has paused.
+     */
+    @JsonProperty("paused")
+    PAUSED,
+
+    /**
+     * Only used during an update to preserve the existing value.
+     */
+    @JsonProperty("unspecified")
+    UNSPECIFIED,
+}

azd/src/main/java/org/azd/helpers/Utils.java

@@ -1,23 +1,44 @@
 package org.azd.helpers;
 
 import java.io.ByteArrayOutputStream;
+import java.io.File;
+import java.io.IOException;
 import java.io.InputStream;
+import java.nio.file.Files;
 import java.util.Arrays;
 import java.util.Base64;
 import java.util.Objects;
 import java.util.stream.Collectors;
 
+/**
+ * Utility class that exposes helper methods.
+ */
 public final class Utils extends URLHelper {
+    /**
+     * Converts int array of values to string with ',' separated.
+     * @param values int array of values.
+     * @return A comma separated string values.
+     */
     public static String toString(int... values) {
         if (values == null) return null;
         return Arrays.stream(values).mapToObj(String::valueOf).collect(Collectors.joining(","));
     }
 
+    /**
+     * Converts string array of values to a comma separated string.
+     * @param values String array of values.
+     * @return A comma separated string values.
+     */
     public static String toString(String... values) {
         if (values == null) return null;
         return String.join(",", values);
     }
 
+    /**
+     * Converts object array of values to a comma separated string.
+     * @param values Object array of values.
+     * @return A comma separated string values.
+     */
     public static String toString(Object... values) {
         if (values == null) return null;
         StringBuilder sb = new StringBuilder();
@@ -30,6 +51,11 @@ public static String toString(Object... values) {
         return sb.toString();
     }
 
+    /**
+     * Converts integer array to string array.
+     * @param values Integer array of values.
+     * @return String array of values.
+     */
     public static String[] toStringArray(int... values) {
         if (values == null) return null;
 
@@ -39,6 +65,12 @@ public static String[] toStringArray(int... values) {
                 .toArray(String[]::new);
     }
 
+    /**
+     * Coverts string array of values to a comma separated encoded string. For instance, if a string contains space
+     * it will be encoded as %20.
+     * @param values String array of values.
+     * @return Comma separated string of values.
+     */
     public static String toEncodedString(String... values) {
         if (values == null) return null;
         return Arrays.stream(values)
@@ -47,14 +79,39 @@ public static String toEncodedString(String... values) {
                 .collect(Collectors.joining(","));
     }
 
+    /**
+     * Checks if a given string value is null or empty.
+     * @param value String value to verify.
+     * @return True if given string is null or empty and false if not.
+     */
     public static boolean isNullOrEmpty(String value) {
         var isNullOrEmpty = true;
         if (value == null) return isNullOrEmpty;
         if (value.isEmpty() || value.isBlank()) return isNullOrEmpty;
         return false;
     }
 
-    public static String toBase64String(InputStream inputStream) throws Exception {
+    /**
+     * Converts the given file contents to base64 encoded string.
+     * @param file File object.
+     * @return Base64 encoded string.
+     */
+    public static String toBase64String(File file) {
+        Objects.requireNonNull(file);
+        try {
+            byte[] content = Files.readAllBytes(file.toPath());
+            return Base64.getEncoder().encodeToString(content);
+        } catch (IOException e) {
+            throw new RuntimeException(e);
+        }
+    }
+
+    /**
+     * Converts a given input stream to base64 string.
+     * @param inputStream Input stream to convert to base64 string.
+     * @return Base64 encoded string value.
+     */
+    public static String toBase64String(InputStream inputStream) {
         Objects.requireNonNull(inputStream, "Input stream cannot be null or empty.");
 
         try (ByteArrayOutputStream outputStream = new ByteArrayOutputStream()) {
@@ -64,8 +121,9 @@ public static String toBase64String(InputStream inputStream) throws Exception {
                 outputStream.write(buffer, 0, bytesRead);
             }
 
-            var encodedBytes = Base64.getEncoder().encode(outputStream.toByteArray());
-            return new String(encodedBytes);
+            return Base64.getEncoder().encodeToString(outputStream.toByteArray());
+        } catch (IOException e) {
+            throw new RuntimeException(e);
         }
     }
 }

azd/src/main/java/org/azd/memberentitlementmanagement/userentitlementsummary/UserEntitlementSummaryRequestBuilder.java

@@ -2,6 +2,7 @@
 
 import org.azd.abstractions.BaseRequestBuilder;
 import org.azd.authentication.AccessTokenCredential;
+import org.azd.common.ApiVersion;
 import org.azd.exceptions.AzDException;
 import org.azd.helpers.Utils;
 import org.azd.memberentitlementmanagement.types.UsersSummary;
@@ -19,7 +20,8 @@ public class UserEntitlementSummaryRequestBuilder extends BaseRequestBuilder {
      * @param accessTokenCredential Access token credential object.
      */
     public UserEntitlementSummaryRequestBuilder(String organizationUrl, AccessTokenCredential accessTokenCredential) {
-        super(organizationUrl, accessTokenCredential, "memberEntitlementManagement", "5ae55b13-c9dd-49d1-957e-6e76c152e3d9");
+        super(organizationUrl, accessTokenCredential, "memberEntitlementManagement", "5ae55b13-c9dd-49d1-957e-6e76c152e3d9",
+                ApiVersion.MEMBERSHIP_ENTITLEMENT_MANAGEMENT);
     }
 
     /**

azd/src/main/java/org/azd/test/TestRequestBuilder.java

@@ -5,8 +5,13 @@
 import org.azd.test.attachments.AttachmentsRequestBuilder;
 import org.azd.test.codecoverage.CodeCoverageRequestBuilder;
 import org.azd.test.iterations.IterationsRequestBuilder;
+import org.azd.test.points.PointsRequestBuilder;
 import org.azd.test.results.ResultsRequestBuilder;
 import org.azd.test.runs.RunsRequestBuilder;
+import org.azd.test.session.SessionRequestBuilder;
+import org.azd.test.testcases.TestCasesRequestBuilder;
+import org.azd.test.testhistory.TestHistoryRequestBuilder;
+import org.azd.test.testsuites.TestSuitesRequestBuilder;
 
 /**
  * Provides functionality to work with Test Api.
@@ -66,4 +71,49 @@ public CodeCoverageRequestBuilder codeCoverage() {
     public IterationsRequestBuilder iterations() {
         return new IterationsRequestBuilder(organizationUrl, accessTokenCredential);
     }
+  
+    /**
+     * Provides functionality to work with Test session Api.
+     *
+     * @return SessionRequestBuilder {@link SessionRequestBuilder}
+     */
+    public SessionRequestBuilder session() {
+        return new SessionRequestBuilder(organizationUrl, accessTokenCredential);
+    }
+
+    /**
+     * Provides functionality to work with Test suites Api.
+     *
+     * @return TestSuitesRequestBuilder {@link TestSuitesRequestBuilder}
+     */
+    public TestSuitesRequestBuilder testSuites() {
+        return new TestSuitesRequestBuilder(organizationUrl, accessTokenCredential);
+    }
+
+    /**
+     * Provides functionality to work with Test cases Api.
+     *
+     * @return TestCasesRequestBuilder {@link TestCasesRequestBuilder}
+     */
+    public TestCasesRequestBuilder testCases() {
+        return new TestCasesRequestBuilder(organizationUrl, accessTokenCredential);
+    }
+
+    /**
+     * Provides functionality to work with Test history Api.
+     *
+     * @return TestHistoryRequestBuilder {@link TestHistoryRequestBuilder}
+     */
+    public TestHistoryRequestBuilder testHistory() {
+        return new TestHistoryRequestBuilder(organizationUrl, accessTokenCredential);
+    }
+
+    /**
+     * Provides functionality to work with Test points Api.
+     *
+     * @return PointsRequestBuilder {@link PointsRequestBuilder}
+     */
+    public PointsRequestBuilder points() {
+        return new PointsRequestBuilder(organizationUrl, accessTokenCredential);
+    }
 }