Merge pull request #154 from katalon-studio/master

Release 20/12

Dockerfile

@@ -36,9 +36,8 @@ ENV DISPLAY_CONFIGURATION='1024x768x24'
 # Agent Environment
 ENV AGENT_NAME='Katalon Agent'
 ENV SERVER_URL='https://testops.katalon.io'
-ENV KATALON_USERNAME=''
 ENV KATALON_API_KEY=''
-ENV TEAM_ID=''
+ENV ORGANIZATION_ID=''
 ENV PROXY=''
 ENV LOG_LEVEL='INFO'
 ENV XVFB_RUN=''

README.md

@@ -19,7 +19,7 @@ agentName=My Agent
 email=<email>
 apikey=<api_key>
 serverUrl=https://analytics.katalon.com/
-teamId=<team_id>
+organizationId=<organization_id>
 ```
 
 - Supported options:
@@ -30,7 +30,7 @@ teamId=<team_id>
 | email     | The email of the Katalon account used to log into the Katalon TestOps. |
 | apikey    | The API Key used to log into the Katalon TestOps. The API key can be generated and retrieved from [here](https://analytics.katalon.com/user/apikey). For more info read the [docs](https://docs.katalon.com/katalon-analytics/docs/ka-api-key.html#katalon-api-keys-usage). |
 | serverUrl | The Katalon TestOps' URL. |
-| teamId    | The ID of the Katalon TestOps team to integrate the Katalon Agent into. The agent is shared among members and projects within a team. |
+| organizationId    | The ID of the Katalon TestOps organization to integrate the Katalon Agent into. The agent is shared among members and projects within an organization that the agent linked to. |
 | uuid      | The ID used to identify the agent. It is generated by the Katalon Agent on the first run and should not be specified manually or modified for any reason. |
 
 | Optional Option | Description |
@@ -67,7 +67,7 @@ Note: On Linux and MacOS, you might need to add execute permission (`chmode u+x
 
 ## Generate the configuration file
 - The `agentconfig` file can be generated or updated by running `config` command with additional arguments.
-- E.g. `node cli.js config --server-url https://analytics.katalon.com --username <email> --apikey <api_key> --teamid <team_id> --agent-name my-agent`
+- E.g. `node cli.js config --server-url https://analytics.katalon.com --username <email> --apikey <api_key> --organizationid <organization_id> --agent-name my-agent`
 - If an `agentconfig` has been created, the existing configuration will be overridden with the new value.
 - Show the usage of the `config` command with `-h` option. E.g. `node cli.js config -h`.
 

agentconfig_template

@@ -3,6 +3,6 @@ agentName=
 email=
 apikey=
 serverUrl=
-teamId=
+organizationId=
 keepFiles=false
 logLevel=INFO

cli.js

@@ -26,7 +26,7 @@ program
   .option('-s, --server-url <value>', 'Katalon Analytics URL')
   .option('-u, --username <value>', 'Email')
   .option('-p, --apikey <value>', 'API key')
-  .option('-t, --teamid <value>', 'Team ID')
+  .option('-t, --organizationid <value>', 'Organization ID')
   .option('-a, --agent-name <value>', 'Agent name')
   .option('-c, --config <value>', 'Configuration file path')
   .option('-x, --proxy <value>', 'HTTTP/HTTPS Proxy')
@@ -40,7 +40,7 @@ program
       serverUrl: command.serverUrl,
       email: command.username,
       apikey: command.apikey,
-      teamId: command.teamid,
+      organizationId: command.organizationid,
       agentName: command.agentName,
       configPath: command.config,
       proxy: command.proxy,
@@ -58,7 +58,7 @@ program
   .option('-s, --server-url <value>', 'Katalon Analytics URL')
   .option('-u, --username <value>', 'Email')
   .option('-p, --apikey <value>', 'API key')
-  .option('-t, --teamid <value>', 'Team ID')
+  .option('-t, --organizationid <value>', 'Organization ID')
   .option('-a, --agent-name <value>', 'Agent name')
   .option('-c, --config <value>', 'Configuration file path')
   .option('-x, --proxy <value>', 'HTTTP/HTTPS Proxy')
@@ -68,7 +68,7 @@ program
       serverUrl: command.serverUrl,
       email: command.username,
       apikey: command.apikey,
-      teamId: command.teamid,
+      organizationId: command.organizationid,
       agentName: command.agentName,
       configPath: command.config,
       proxy: command.proxy,

docker/scripts/agent.sh

@@ -11,9 +11,8 @@ cd $KATALON_AGENT_DIR
 
 ./cli-linux-x64 config \
     --server-url "$SERVER_URL" \
-    --username "$KATALON_USERNAME" \
     --apikey "$KATALON_API_KEY" \
-    --teamid "$TEAM_ID" \
+    --organizationid "$ORGANIZATION_ID" \
     --agent-name "$AGENT_NAME" \
     --proxy "$PROXY" \
     --log-level "$LOG_LEVEL" \

package.json

@@ -1,6 +1,6 @@
 {
   "name": "katalon-agent",
-  "version": "v1.7.8",
+  "version": "v2.0.0",
   "description": "",
   "main": "cli.js",
   "scripts": {

src/core/api/api.js

@@ -4,6 +4,13 @@ const http = require('./http');
 const httpInternal = require('./http-testops');
 const urlParam = require('./url-param');
 const { getBasicAuthHeader } = require('./utils');
+const { getAuth } = require('../auth');
+
+function withAuthorization(apiKey) {
+  return {
+    Authorization: getBasicAuthHeader(getAuth(apiKey)),
+  };
+}
 
 module.exports = {
   requestToken(email, password) {
@@ -29,8 +36,8 @@ module.exports = {
     return httpInternal.post(urlParam.accessToken(), data);
   },
 
-  getUploadInfo(projectId) {
-    return httpInternal.get(urlParam.getUploadInfo(projectId));
+  getUploadInfo(projectId, apiKey) {
+    return httpInternal.get(urlParam.getUploadInfo(projectId), withAuthorization(apiKey));
   },
 
   uploadFile(uploadUrl, filePath) {
@@ -45,6 +52,7 @@ module.exports = {
     uploadedPath,
     isEnd,
     reportType,
+    apiKey,
     extraParams = {},
   ) {
     return httpInternal.post(
@@ -58,43 +66,45 @@ module.exports = {
         reportType,
         extraParams,
       ),
+      null,
+      this.withAuthorization(apiKey),
     );
   },
 
   pingAgent(body) {
     return httpInternal.post(urlParam.pingAgent(), body);
   },
 
-  pingJob(jobId) {
-    return httpInternal.patch(urlParam.pingJob(jobId));
+  pingJob(jobId, apiKey) {
+    return httpInternal.patch(urlParam.pingJob(jobId), null, withAuthorization(apiKey));
   },
 
-  requestJob(uuid, teamId) {
-    return httpInternal.get(urlParam.requestJob(uuid, teamId));
+  requestJob(uuid, organizationId) {
+    return httpInternal.get(urlParam.requestJob(uuid, organizationId));
   },
 
-  updateJob(body) {
-    return httpInternal.post(urlParam.updateJob(), body);
+  updateJob(body, apiKey) {
+    return httpInternal.post(urlParam.updateJob(), body, withAuthorization(apiKey));
   },
 
-  saveJobLog(jobInfo, batch, fileName) {
-    return httpInternal.post(urlParam.saveJobLog(jobInfo, batch, fileName));
+  saveJobLog(jobInfo, batch, fileName, apiKey) {
+    return httpInternal.post(urlParam.saveJobLog(jobInfo, batch, fileName), null, withAuthorization(apiKey));
   },
 
-  notifyJob(jobId, projectId) {
-    return httpInternal.post(urlParam.notifyJob(jobId, projectId));
+  notifyJob(jobId, projectId, apiKey) {
+    return httpInternal.post(urlParam.notifyJob(jobId, projectId), null, withAuthorization(apiKey));
   },
 
   getBuildInfo() {
     return httpInternal.get(urlParam.getBuildInfo());
   },
 
-  updateNodeStatus(jobId, nodeStatus) {
+  updateNodeStatus(jobId, nodeStatus, apiKey) {
     const data = {
       id: jobId,
       nodeStatus,
     };
-    return httpInternal.put(urlParam.updateNodeStatus(), data);
+    return httpInternal.put(urlParam.updateNodeStatus(), data, withAuthorization(apiKey));
   },
 
   getKSReleases() {
@@ -105,7 +115,7 @@ module.exports = {
     return http.stream(urlParam.download(url), filePath);
   },
 
-  downloadFromTestOps(url, filePath) {
-    return httpInternal.stream(urlParam.download(url), filePath);
+  downloadFromTestOps(url, filePath, apiKey) {
+    return httpInternal.stream(urlParam.download(url), filePath, withAuthorization(apiKey));
   },
 };

src/core/api/http-testops.js

@@ -4,7 +4,7 @@ const { getBasicAuthHeader } = require('./utils');
 
 function withAuthorization(current = {}) {
   return {
-    Authorization: getBasicAuthHeader(getAuth()),
+    Authorization: (current && current.Authorization) ? current.Authorization : getBasicAuthHeader(getAuth()),
     ...current,
   };
 }

src/core/api/url-param.js

@@ -53,10 +53,10 @@ module.exports = {
     return buildUrl({}, PATHS.JOB, jobId);
   },
 
-  requestJob(uuid, teamId) {
+  requestJob(uuid, organizationId) {
     const params = {
       uuid,
-      teamId,
+      organizationId,
     };
     return buildUrl({ params }, PATHS.JOB, 'get-job');
   },

src/core/auth.js

@@ -1,9 +1,9 @@
 const config = require('./config');
 
-function getAuth() {
+function getAuth(apikey) {
   return {
     username: '',
-    password: config.apikey,
+    password: apikey || config.apikey,
   };
 }
 

src/core/file.js

@@ -7,7 +7,7 @@ const fs = require('fs-extra');
 const api = require('./api');
 const defaultLogger = require('../config/logger');
 
-function download(downloadMethod, url, logger = defaultLogger) {
+function download(downloadMethod, url, logger = defaultLogger, apiKey) {
   logger.info(`Downloading from ${url}. It may take a few minutes.`);
   const file = tmp.fileSync();
   const filePath = file.name;
@@ -19,7 +19,7 @@ function download(downloadMethod, url, logger = defaultLogger) {
     }
     return Promise.reject(new Error(`Unable to download from ${url} to ${filePath}`));
   };
-  return downloadMethod(url, filePath)
+  return downloadMethod(url, filePath, apiKey)
     .then(verifyDownloadedFile);
 }
 
@@ -57,8 +57,8 @@ module.exports = {
     );
   },
 
-  downloadFromTestOps(url, targetPath, logger = defaultLogger) {
-    return download(api.downloadFromTestOps, url, logger).then((filePath) =>
+  downloadFromTestOps(url, targetPath, apiKey, logger = defaultLogger) {
+    return download(api.downloadFromTestOps, url, logger, apiKey).then((filePath) =>
       this.move(filePath, targetPath, logger),
     );
   },

src/helper/agent.js

@@ -24,7 +24,6 @@ function buildUpdateJobBody(jobId, jobStatus, processId) {
 
 function createCommandExecutor(
   projectId,
-  teamId,
   ksArgs,
   x11Display,
   xvfbConfiguration,
@@ -42,7 +41,7 @@ function createCommandExecutor(
   }
 
   const info = {
-    teamId,
+    teamId: parameter.teamId,
     projectId,
     ksVersionNumber: parameter.ksVersion,
     ksLocation: parameter.ksLocation,