Release/v2.3.0

.github/workflows/composite/generate-sdk/action.yml

@@ -1,6 +1,9 @@
 name: 'Generate SDK'
 description: 'Generate SDK for a given API'
 inputs:
+  spec-link: 
+    description: 'Link to the spec file.'
+    required: true
   package-name:
     description: 'Name of the go module.'
     required: true

.github/workflows/composite/lint-sdk/action.yml

@@ -9,7 +9,9 @@ runs:
   steps:
     - name: Install golang
       shell: bash
-      run: sudo apt-get install golang-go
+      run: |
+        sudo apt-get update 
+        sudo apt-get install golang-go
     - name: Lint module
       shell: bash
       run: cd ${{ inputs.module-name }} && go vet ./...

.github/workflows/composite/test-sdk/action.yml

@@ -0,0 +1,28 @@
+name: 'Test SDK'
+description: 'Test SDK using a given test file.'
+inputs:
+  test-suite: 
+    description: 'Name of the test suite to run.'
+    required: true
+runs:
+  using: "composite"
+  steps:
+    - name: Install golang
+      shell: bash
+      run: |
+        sudo apt-get update
+        sudo apt-get install golang-go
+    - name: Run tests
+      shell: bash
+      run: |
+        cd tests
+        export GOPATH="$HOME/go/"
+        export PATH=$PATH:$GOPATH/bin
+        go install github.com/jstemmer/go-junit-report
+        go test -v -run ${{ inputs.test-suite }} | go-junit-report -set-exit-code > ${{inputs.test-suite}}.xml
+    - name: Upload Test Results
+      if: always()
+      uses: actions/upload-artifact@v2
+      with:
+        name: Test Results
+        path: 'tests/*'

.github/workflows/generate-sdk.yml

@@ -4,6 +4,7 @@ on:
   pull_request:
     branches:
       - develop
+      - 'release/**'
   schedule:
     - cron: '15 */4 * * *'
 
@@ -69,7 +70,7 @@ jobs:
   push-changes:
     name: Push Changes
     runs-on: ubuntu-latest
-    if: startsWith(github.head_ref, 'release') == false && github.head_ref != 'master'  && github.event.pull_request.head.repo.full_name == 'phoenixnap/go-sdk-bmc'
+    if: startsWith(github.head_ref, 'release') == false && startsWith(github.base_ref, 'release') == false && github.head_ref != 'master' && github.base_ref != 'master' && github.event.pull_request.head.repo.full_name == 'phoenixnap/go-sdk-bmc'
     needs:
       - generate-bmcapi
       - generate-rancherapi
@@ -247,15 +248,117 @@ jobs:
         with:
           module-name: tagapi
 
-  publish-test-results:
-    name: Publish Test Results
+  test-auditapi:
+    name: Test Audit API
+    runs-on: ubuntu-latest
+    needs:
+      - lint-auditapi
+    services:
+      mockserver:
+        image: mockserver/mockserver:5.13.0
+        ports:
+          - 1080:1080
+    steps:
+      - uses: actions/checkout@v2
+      - name: Download Artifacts
+        uses: actions/download-artifact@v2
+      - uses: ./.github/workflows/composite/test-sdk
+        with:
+          test-suite: TestAuditApiTestSuite
+  test-ipapi:
+    name: Test IP API
+    runs-on: ubuntu-latest
+    needs:
+      - lint-ipapi
+    services:
+      mockserver:
+        image: mockserver/mockserver:5.13.0
+        ports:
+          - 1080:1080
+    steps:
+      - uses: actions/checkout@v2
+      - name: Download Artifacts
+        uses: actions/download-artifact@v2
+      - uses: ./.github/workflows/composite/test-sdk
+        with:
+          test-suite: TestIpApiTestSuite
+  test-bmcapi:
+    name: Test BMC API
+    runs-on: ubuntu-latest
     needs:
       - lint-bmcapi
+    services:
+      mockserver:
+        image: mockserver/mockserver:5.13.0
+        ports:
+          - 1080:1080
+    steps:
+      - uses: actions/checkout@v2
+      - name: Download Artifacts
+        uses: actions/download-artifact@v2
+      - uses: ./.github/workflows/composite/test-sdk
+        with:
+          test-suite: TestBmcApiTestSuite
+  test-tagapi:
+    name: Test Tag API
+    runs-on: ubuntu-latest
+    needs:
+      - lint-tagapi
+    services:
+      mockserver:
+        image: mockserver/mockserver:5.13.0
+        ports:
+          - 1080:1080
+    steps:
+      - uses: actions/checkout@v2
+      - name: Download Artifacts
+        uses: actions/download-artifact@v2
+      - uses: ./.github/workflows/composite/test-sdk
+        with:
+          test-suite: TestTagApiTestSuite
+  test-rancherapi:
+    name: Test Rancher API
+    runs-on: ubuntu-latest
+    needs:
       - lint-rancherapi
+    services:
+      mockserver:
+        image: mockserver/mockserver:5.13.0
+        ports:
+          - 1080:1080
+    steps:
+      - uses: actions/checkout@v2
+      - name: Download Artifacts
+        uses: actions/download-artifact@v2
+      - uses: ./.github/workflows/composite/test-sdk
+        with:
+          test-suite: TestRancherSolutionApiTestSuite
+  test-networkapi:
+    name: Test Network API
+    runs-on: ubuntu-latest
+    needs:
       - lint-networkapi
-      - lint-ipapi
-      - lint-auditapi
-      - lint-tagapi
+    services:
+      mockserver:
+        image: mockserver/mockserver:5.13.0
+        ports:
+          - 1080:1080
+    steps:
+      - uses: actions/checkout@v2
+      - name: Download Artifacts
+        uses: actions/download-artifact@v2
+      - uses: ./.github/workflows/composite/test-sdk
+        with:
+          test-suite: TestNetworkApiTestSuite
+  publish-test-results:
+    name: Publish Test Results
+    needs:
+      - test-bmcapi
+      - test-rancherapi
+      - test-networkapi
+      - test-ipapi
+      - test-auditapi
+      - test-tagapi
     runs-on: ubuntu-latest
     if: always()
     steps:
@@ -268,3 +371,5 @@ jobs:
         with:
           files: test-reports/**/*.xml
           check_name: "Test Results"
+
+

tests/README.md

@@ -0,0 +1,27 @@
+# Tests
+
+## Setup
+
+To run tests you'll need to run an instance of `mockserver` running at port 1080. This can be done using Docker:
+- Install docker
+- Prepare and start `mockserver` by running the following: `docker run --name mockserver -d --rm -p 1080:1080 mockserver/mockserver:5.13.0`
+
+You can then get logs from the mock server by running `docker logs -f mockserver`. The container id can be found using `docker ps`.
+
+Once you're done, you can stop the mock server by running `docker container stop -f mockserver`.
+
+Alternatively, you can also run an instance of `portainer` by running the following command: `docker run -d -p 9000:9000 --restart always -v /var/run/docker.sock:/var/run/docker.sock -v /opt/portainer:/data portainer/portainer`. Going to `localhost:9000` will then give you a GUI where you can stop, start, and look at the logs for `mockserver`.
+
+## Running
+
+Tests can be run per-module by running its respective `tc_` script, or all at once by running `ts_sdk.rb`:
+
+```sh
+bundler exec ruby ./ts_sdk.rb
+```
+
+## Payloads
+
+Payloads are created according to the mockserver documentation. In addition, they are formatted using `jq`. 
+
+To format any additional payloads, install `jq` by doing `sudo apt-get install jq`, then run `format.sh` while inside the `payloads` folder.

tests/audit_api_test.go

@@ -0,0 +1,96 @@
+package tests
+
+import (
+	"context"
+	"encoding/json"
+	"fmt"
+	"os"
+	"strconv"
+	"testing"
+	"time"
+
+	"github.com/phoenixnap/go-sdk-bmc/auditapi"
+	"github.com/stretchr/testify/suite"
+)
+
+type AuditApiTestSuite struct {
+	suite.Suite
+	ctx           context.Context
+	configuration *auditapi.Configuration
+	apiClient     *auditapi.APIClient
+}
+
+func (suite *AuditApiTestSuite) SetupSuite() {
+	// Set configuration
+	suite.configuration = auditapi.NewConfiguration()
+	suite.configuration.Host = "127.0.0.1:1080"
+	suite.configuration.Scheme = "http"
+	// Set the context background
+	suite.ctx = context.WithValue(context.Background(), "accessToken", "ACCESSTOKENSTRING")
+	suite.ctx = context.WithValue(suite.ctx, "serverIndex", nil)
+	fmt.Println(">>> From SetupSuite")
+	suite.apiClient = auditapi.NewAPIClient(suite.configuration)
+}
+
+// this function executes after all tests executed
+func (suite *AuditApiTestSuite) TearDownTest() {
+	fmt.Println(">>> From TearDownSuite")
+	TestUtilsImpl{}.resetExpectations()
+}
+
+func (suite *AuditApiTestSuite) verifyCalledOnce(expectationId string) {
+	// Result retrieved from server's verification
+	// Verifying expectation matched exactly once.
+	verifyResult := TestUtilsImpl{}.verifyExpectationMatchedTimes(expectationId, 1)
+
+	// Asserts a successful result
+	suite.Equal(202, verifyResult.StatusCode)
+}
+
+func (suite *AuditApiTestSuite) Test_get_events_all_query_params() {
+
+	// Generate payload
+	request, response := TestUtilsImpl{}.generatePayloadsFrom("auditapi/events_get", "./payloads")
+
+	// Extract the response expectation id
+	expectationId := TestUtilsImpl{}.setupExpectation(request, response, 1)
+
+	// Fetch a map of query parameters
+	qpMap := TestUtilsImpl{}.generateQueryParams(request)
+
+	// Converting to int32
+	limitstring, ok := qpMap["limit"].(string)
+	if !ok {
+		panic(ok)
+	}
+
+	from, _ := time.Parse(time.RFC3339, request.QueryStringParameters[0].Values[0]) 
+	to, _ := time.Parse(time.RFC3339, request.QueryStringParameters[1].Values[0])   
+	limit64, _ := strconv.ParseInt(limitstring, 10, 32)
+	limit := int32(limit64)                          
+	order := fmt.Sprintf("%v", qpMap["order"])       
+	username := fmt.Sprintf("%v", qpMap["username"]) 
+	verb := fmt.Sprintf("%v", qpMap["verb"])         
+	uri := fmt.Sprintf("%v", qpMap["uri"])
+
+	// Operation Execution
+	result, r, err := suite.apiClient.EventsApi.EventsGet(suite.ctx).From(from).To(to).Limit(limit).Order(order).Username(username).Verb(verb).Uri(uri).Execute()
+	if err != nil {
+		fmt.Fprintf(os.Stderr, "Error when calling `EventsApi.EventsGet``: %v\n", err)
+		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
+	}
+
+	// Convert the result and response body to json strings
+	jsonResult, _ := json.Marshal(result)
+	jsonResponseBody, _ := json.Marshal(response.Body)
+
+	// Asserts
+	suite.Equal(jsonResult, jsonResponseBody)
+
+	// Verify
+	suite.verifyCalledOnce(expectationId)
+}
+
+func TestAuditApiTestSuite(t *testing.T) {
+	suite.Run(t, new(AuditApiTestSuite))
+}