https://github.com/parasoft/disconnect-server-action

A GitHub Action for disconnecting a temporary Virtualize server from a remote Parasoft Continuous Testing Platform
https://github.com/parasoft/disconnect-server-action

api ctp disconnect environment parasoft server service soatest testing virtualization virtualize

Last synced: 2 months ago
JSON representation

A GitHub Action for disconnecting a temporary Virtualize server from a remote Parasoft Continuous Testing Platform

• Host: GitHub
• URL: https://github.com/parasoft/disconnect-server-action
• Owner: parasoft
• License: apache-2.0
• Created: 2021-01-18T18:47:04.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2023-01-24T17:07:06.000Z (almost 2 years ago)
• Last Synced: 2024-11-17T20:48:35.777Z (2 months ago)
• Topics: api, ctp, disconnect, environment, parasoft, server, service, soatest, testing, virtualization, virtualize
• Language: TypeScript
• Homepage: https://www.parasoft.com/
• Size: 535 KB
• Stars: 10
• Watchers: 7
• Forks: 17
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


  



# Disconnect a server

This action disconnects a Parasoft Virtualize server from a given Continous Testing Platform endpoint.

## Usage

Add the following entry to your Github workflow YAML file with the required inputs:

Password will use a github encrypted secret. Please reference [Encrypted Secrets Documentation](https://docs.github.com/en/actions/reference/encrypted-secrets) on how to create an encrypted secret.

```yaml

uses: parasoft/disconnect-server-action@v1

with:

  ctpUrl: 'http://exampleUrl'

  ctpUsername: 'username'

  ctpPassword: ${{ secrets.password }}

  serverMatch: 'host'

  server: 'localhost'

```

### Required Inputs 

The following inputs are required for this action:

| Input | Description |

| --- | --- |

| `ctpURL` | Specifies the Continuous Testing Platform endpoint where the environment will be deployed. |

| `ctpUsername` | Specifies a user name for accessing the Continuous Testing Platform endpoint. |

| `ctpPassword` | Specifies a Github encrypted secret for accessing the Continuous Testing Platform endpoint. Refer to the [Encrypted Secrets Documentation](https://docs.github.com/en/actions/reference/encrypted-secrets) for details on how to create an encrypted secret. |

| `serverMatch` | Specifies how to identify the server to disconnect. The following strings are valid: 


`host`: Configures the action to identify the host by IP.

`name`: Confiugres the action to identify the host by name.

 |

| `server` |  Specifies either the host name or IP address to disconnect depending on the `serverMatch` input configuration. |


## Build and Test this Action Locally

1. Install the dependencies:

```bash

$ npm install

```

2. Build the typescript and package it for distribution: 

```bash

$ npm run build && npm run package

```

3. Run the tests:

```bash

$ npm test

 PASS  ./index.test.js

...

```