Test IT TMS Adapter for Golang

Getting Started

Installation

go get github.com/testit-tms/adapters-go/pkg/tms

Usage

Configuration

Description	File property	Environment variable
Location of the TMS instance	url	TMS_URL
API secret key How to getting API secret key?	privateToken	TMS_PRIVATE_TOKEN
ID of project in TMS instance How to getting project ID?	projectId	TMS_PROJECT_ID
ID of configuration in TMS instance How to getting configuration ID?	configurationId	TMS_CONFIGURATION_ID
ID of the created test run in TMS instance.	testRunId	TMS_TEST_RUN_ID
Adapter mode. Default value - 0. The adapter supports following modes: 0 - in this mode, the adapter filters tests by test run ID and configuration ID, and sends the results to the test run 1 - in this mode, the adapter sends all results to the test run without filtering 2 - in this mode, the adapter creates a new test run and sends results to the new test run	adapterMode	TMS_ADAPTER_MODE
It enables/disables certificate validation (It's optional). Default value - true	certValidation	TMS_CERT_VALIDATION
Mode of automatic creation test cases (It's optional). Default value - false. The adapter supports following modes: true - in this mode, the adapter will create a test case linked to the created autotest (not to the updated autotest) false - in this mode, the adapter will not create a test case	automaticCreationTestCases	TMS_AUTOMATIC_CREATION_TEST_CASES
Mode of automatic updation links to test cases (It's optional). Default value - false. The adapter supports following modes: true - in this mode, the adapter will update links to test cases false - in this mode, the adapter will not update link to test cases	automaticUpdationLinksToTestCases	TMS_AUTOMATIC_UPDATION_LINKS_TO_TEST_CASES
Enable debug logs (It's optional). Default value - false	isDebug	TMS_IS_DEBUG

File

Create tms.config.json file in the project directory:

{
  "url": "URL",
  "privateToken": "USER_PRIVATE_TOKEN",
  "projectId": "PROJECT_ID",
  "configurationId": "CONFIGURATION_ID",
  "testRunId": "TEST_RUN_ID",
  "automaticCreationTestCases": false,
  "automaticUpdationLinksToTestCases": false,
  "certValidation": true,
  "adapterMode": 1,
  "isDebug": true
}

How to run

If you specified TestRunId, then just run the command:

export TMS_CONFIG_FILE=<ABSOLUTE_PATH_TO_CONFIG_FILE>
cd examples
go test

To create and complete TestRun you can use the Test IT CLI:

export TMS_TOKEN=<YOUR_TOKEN>
testit \
  --mode create
  --url https://tms.testit.software \
  --project-id 5236eb3f-7c05-46f9-a609-dc0278896464 \
  --testrun-name "New test run" \
  --output tmp/output.txt

export TMS_TEST_RUN_ID=$(cat output.txt)  

export TMS_CONFIG_FILE=<ABSOLUTE_PATH_TO_CONFIG_FILE>
cd examples
go test

testit \
  --mode finish
  --url https://tms.testit.software \
  --testrun-id $(cat tmp/output.txt) 

Run with filter

To create filter by autotests you can use the Test IT CLI (use adapterMode 1 for run with filter):

$ export TMS_TOKEN=<YOUR_TOKEN>
$ testit autotests_filter 
  --url https://tms.testit.software \
  --configuration-id 5236eb3f-7c05-46f9-a609-dc0278896464 \
  --testrun-id 6d4ac4b7-dd67-4805-b879-18da0b89d4a8 \
  --framework golang \
  --output tmp/filter.txt

$ export TMS_TEST_RUN_ID=6d4ac4b7-dd67-4805-b879-18da0b89d4a8
$ export TMS_ADAPTER_MODE=1

$ export TMS_CONFIG_FILE=<ABSOLUTE_PATH_TO_CONFIG_FILE>
$ go test -run "$(cat tmp/filter.txt)"

Metadata of autotest

Use metadata to specify information about autotest.

Description of metadata:

• WorkItemIds - a method that links autotests with manual tests. Receives the array of manual tests' IDs
• DisplayName - internal autotest name (used in Test IT)
• ExternalId - unique internal autotest ID (used in Test IT)
• Title - autotest name specified in the autotest card. If not specified, the name from the displayName method is used
• Description - autotest description specified in the autotest card
• Labels - tags listed in the autotest card
• Links - links listed in the autotest card
• Step - the designation of the step

Description of methods:

• tms.AddLinks - add links to the autotest result.
• tms.AddAttachments - add attachments to the autotest result.
• tms.AddAtachmentsFromString - add attachments from string to the autotest result.
• tms.AddMessage - add message to the autotest result.

Examples

Simple test

import (
"testing"

"github.com/testit-tms/adapters-go/pkg/tms"
)

func TestSteps_Success(t *testing.T) {
tms.Test(t,
tms.TestMetadata{
DisplayName: "steps success",
},
func () {
tms.Step(
tms.StepMetadata{
Name:        "step 1",
Description: "step 1 description",
},
func () {
tms.Step(tms.StepMetadata{
Name:        "step 1.1",
Description: "step 1.1 description",
}, func () {
tms.Step(tms.StepMetadata{}, func () {
tms.True(t, true)
})
tms.True(t, true)
})
tms.True(t, true)
},
)
tms.Step(
tms.StepMetadata{
Name:        "step 2",
Description: "step 2 description",
},
func () {
tms.Step(tms.StepMetadata{
Name:        "step 2.1",
Description: "step 2.1 description",
}, func () {
tms.Step(tms.StepMetadata{}, func () {
tms.True(t, true)
})
tms.True(t, true)
})
tms.True(t, true)
},
)
})
}

Parameterized test

import (
"testing"

"github.com/testit-tms/adapters-go/pkg/tms"
)

func TestParameters_success(t *testing.T) {
tests := []struct {
name           string
parameters     map[string]interface{}
stepName       string
stepParameters map[string]interface{}
expValue       bool
}{
{
name: "add parameters success",
parameters: map[string]interface{}{
"param1": "value1",
"param2": 15,
},
stepName: "step1",
stepParameters: map[string]interface{}{
"param1": "value1",
"param2": 15,
},
expValue: true,
},
{
name: "add parameters failed",
parameters: map[string]interface{}{
"param1": "value1",
"param2": 15,
},
stepName: "step1",
stepParameters: map[string]interface{}{
"param1": "value1",
"param2": 15,
},
expValue: false,
},
}
for _, tt := range tests {
t.Run(tt.name, func (t *testing.T) {
tms.Test(t, tms.TestMetadata{
DisplayName: tt.name,
Parameters:  tt.parameters,
}, func () {
tms.Step(
tms.StepMetadata{
Name:       tt.stepName,
Parameters: tt.stepParameters,
}, func () {
tms.True(t, tt.expValue)
})
})
})
}
}

Contributing

You can help to develop the project. Any contributions are greatly appreciated.

• If you have suggestions for adding or removing projects, feel free to open an issue to discuss it, or create a direct pull request after you edit the README.md file with necessary changes.
• Make sure to check your spelling and grammar.
• Create individual PR for each suggestion.
• Read the Code Of Conduct before posting your first idea as well.

License

Distributed under the Apache-2.0 License. See LICENSE for more information.