Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nyaran/testlink-xmlrpc
NodeJS module to connect to TestLink using XML-RPC API
https://github.com/nyaran/testlink-xmlrpc
node nodejs nodejs-modules npm npm-module test testing testlink testlinkapi
Last synced: about 16 hours ago
JSON representation
NodeJS module to connect to TestLink using XML-RPC API
- Host: GitHub
- URL: https://github.com/nyaran/testlink-xmlrpc
- Owner: Nyaran
- License: gpl-3.0
- Created: 2018-09-28T10:42:56.000Z (about 6 years ago)
- Default Branch: main
- Last Pushed: 2024-09-17T00:02:50.000Z (2 months ago)
- Last Synced: 2024-09-18T04:47:51.661Z (2 months ago)
- Topics: node, nodejs, nodejs-modules, npm, npm-module, test, testing, testlink, testlinkapi
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/testlink-xmlrpc
- Size: 819 KB
- Stars: 7
- Watchers: 3
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# testlink-xmlrpc
[](https://www.gnu.org/licenses/gpl-3.0)
[](https://github.com/Nyaran/testlink-xmlrpc/actions/workflows/test.yml)
[](https://codecov.io/gh/Nyaran/testlink-xmlrpc)
[](https://www.npmjs.com/package/testlink-xmlrpc)
[](https://github.com/TestLinkOpenSourceTRMS/testlink-code/tree/testlink_1_9_20_fixed)
[](https://ko-fi.com/nyaran)
testlink-xmlrpc is a NodeJS module that connect with TestLink XML-PRC API in order to provide methods to handle Test Suites, Test Case and any other internal functionality exposed in the API.
## Usage
Library is prepared to work with [JS Promises](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise), so you should use them or [Async/Await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/async_function)
````typescript
import {TestLink} from 'testlink-xmlrpc';
const testlink = new TestLink({
host: "testlink.my-server.com",
port: 8080, // Set if you are not using default port
secure: true, // Use https, if you are using http, set to false.
apiKey: "MY_API_KEY", // The API KEY from TestLink. Get it from user profile.
});
````
Now you can interact with TestLink server. E.g.:
### Check connection (with async/await)
````typescript
async function checkConnection() {
let ping = await testlink.sayHello();
if (ping === "Hello!") {
console.log("connection established");
}
}
````
### Validate API KEY (with Promise)
````typescript
testlink.checkDevKey({devKey: 'APIKEY_to_check'}).then(reply => {
if (reply === true)
console.log("API KEY is valid");
else
console.log("API KEY is invalid");
});
````
### Create a Test Case (with async/await)
````typescript
async function createTestCase() {
let testCase = await testlink.createTestCase({
testprojectid: 5, // Project id in TestLink.
testsuiteid: 63, // TestSuite id in TestLink.
testcasename: "This is my new testCase", // Test Case name.
authorlogin: "my_user", // Author of Test Case.
summary: "This Test Case is an example", // Test Case description.
steps: [] // Array containing the Test Case steps.
});
}
````
## Disclaimer
The development of this project is completely separated from TestLink development. So please, before open any issue here or in TestLink issue tracker, make sure you are opening the ticket in the right place.