Use CircleCI version 2.1 at the top of your .circleci/config.yml file.
1
version: 2.1
Add the orbs
stanza below your version, invoking the orb:
1
2
orbs:
accelq-connect: accelq/accelq-connect@1.0.1
Use accelq-connect
elements in your existing workflows and jobs.
Opt-in to use of uncertified orbs on your organization’s Security settings page.
Use ACCELQ Orb to trigger scheduled CI jobs registered in ACCELQ application.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
version: '2.1'
orbs:
accelq-connect: accelq/accelq-connect@1.0.0
workflows:
use-my-orb:
jobs:
- accelq-connect/accelq-ci:
agentName: POC
apiKey: XyzAvsdfwe2322sdf
jobId: '1'
proxyHost: localhost
proxyPort: '9090'
runparams: '{"username": "john todd", "userID": 2}'
tenantCode: demotenant
url: https://poc.accelq.io
userId: vivekop@yopmail.com
Execute ACCELQ registered CI Jobs
PARAMETER | DESCRIPTION | REQUIRED | DEFAULT | TYPE |
---|---|---|---|---|
agentName | Agent Name (Optional) on which you want to run this job | No | '' | string |
apiKey | API key available in Profile section of ACCELQ | Yes | - | env_var_name |
jobId | ACCELQ CI Job Id | Yes | - | string |
proxyHost | Proxy Host (Optional) | No | '' | string |
proxyPort | Proxy Port (Optional) | No | '' | string |
runparams | Run Params (Optional) should be JSON string form example: {"username": "John Todd", "password": "bxW&=UVw"} | No | '' | string |
tenantCode | ACCELQ Tenant Code | Yes | - | string |
url | Your ACCELQ Application URL in the exact following format: https://<hostname>:<port_num> | Yes | - | string |
userId | ACCELQ User ID | Yes | - | string |
This command runs the ACCELQ CI Job using NodeJS make sure its installed.
PARAMETER | DESCRIPTION | REQUIRED | DEFAULT | TYPE |
---|---|---|---|---|
agentName | Agent Name (Optional) on which you want to run this job | No | '' | string |
apiKey | API key available in Profile section of ACCELQ | Yes | - | env_var_name |
jobId | ACCELQ CI Job Id | Yes | - | string |
proxyHost | Proxy Host (Optional) | No | '' | string |
proxyPort | Proxy Port (Optional) | No | '' | string |
runparams | Run Params (Optional) should be JSON string form example: {"username": "John Todd", "password": "bxW&=UVw"} | No | '' | string |
tenantCode | ACCELQ Tenant Code | Yes | - | string |
url | Your ACCELQ Application URL in the exact following format: https://<hostname>:<port_num> | Yes | - | string |
userId | ACCELQ User ID | Yes | - | string |
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
# This code is licensed from CircleCI to the user under the MIT license.
# See here for details: https://circleci.com/developer/orbs/licensing
version: 2.1
description: |
Use ACCELQ Orb to trigger scheduled CI jobs registered in ACCELQ application.
display:
home_url: https://www.accelq.com
source_url: https://github.com/accelq/accelq-connect-orb
commands:
accelq-ci:
description: |
This command runs the ACCELQ CI Job using NodeJS make sure its installed.
parameters:
agentName:
default: ""
description: Agent Name (Optional) on which you want to run this job
type: string
apiKey:
description: API key available in Profile section of ACCELQ
type: env_var_name
jobId:
description: ACCELQ CI Job Id
type: string
proxyHost:
default: ""
description: Proxy Host (Optional)
type: string
proxyPort:
default: ""
description: Proxy Port (Optional)
type: string
runparams:
default: ""
description: 'Run Params (Optional) should be JSON string form example: {"username": "John Todd", "password": "bxW&=UVw"}'
type: string
tenantCode:
description: ACCELQ Tenant Code
type: string
url:
description: 'Your ACCELQ Application URL in the exact following format: https://<hostname>:<port_num>'
type: string
userId:
description: ACCELQ User ID
type: string
steps:
- run:
command: |
wget https://accelq.s3.amazonaws.com/releases/plugins/5.0/accelq_ci_cd.tar.gz
tar xvzf accelq_ci_cd.tar.gz
cd out
ls -al
npm install
node app.js --url << parameters.url >> --tenantCode << parameters.tenantCode >> --apiKey $<< parameters.apiKey >> --userID << parameters.userId >> --jobID << parameters.jobId >> <<#parameters.proxyHost>> --proxyHost <<parameters.proxyHost>> <</parameters.proxyHost>> <<#parameters.proxyPort>> --proxyPort <<parameters.proxyPort>> <</parameters.proxyPort>> <<#parameters.agentName>> --agentName <<parameters.agentName>> <</parameters.agentName>> <<#parameters.runparams>> --runParams <<parameters.runparams>> <</parameters.runparams>>
name: Trigger ACCELQ CI Job
jobs:
ci-cd:
description: |
Execute ACCELQ registered CI Jobs
docker:
- image: cimg/node:lts
parameters:
agentName:
default: ""
description: Agent Name (Optional) on which you want to run this job
type: string
apiKey:
description: API key available in Profile section of ACCELQ
type: env_var_name
jobId:
description: ACCELQ CI Job Id
type: string
proxyHost:
default: ""
description: Proxy Host (Optional)
type: string
proxyPort:
default: ""
description: Proxy Port (Optional)
type: string
runparams:
default: ""
description: 'Run Params (Optional) should be JSON string form example: {"username": "John Todd", "password": "bxW&=UVw"}'
type: string
tenantCode:
description: ACCELQ Tenant Code
type: string
url:
description: 'Your ACCELQ Application URL in the exact following format: https://<hostname>:<port_num>'
type: string
userId:
description: ACCELQ User ID
type: string
steps:
- accelq-ci:
agentName: << parameters.agentName >>
apiKey: << parameters.apiKey >>
jobId: << parameters.jobId >>
proxyHost: << parameters.proxyHost >>
proxyPort: << parameters.proxyPort >>
runparams: << parameters.runparams >>
tenantCode: << parameters.tenantCode >>
url: << parameters.url >>
userId: << parameters.userId >>
examples:
execute_accelq_tests:
description: |
Use ACCELQ Orb to trigger scheduled CI jobs registered in ACCELQ application.
usage:
version: "2.1"
orbs:
accelq-connect: accelq/accelq-connect@1.0.0
workflows:
use-my-orb:
jobs:
- accelq-connect/accelq-ci:
agentName: POC
apiKey: XyzAvsdfwe2322sdf
jobId: "1"
proxyHost: localhost
proxyPort: "9090"
runparams: '{"username": "john todd", "userID": 2}'
tenantCode: demotenant
url: https://poc.accelq.io
userId: vivekop@yopmail.com