Add support for Jira API tokens on server and DC

Author: glibas

README.md

@@ -57,6 +57,8 @@ import * as assertThat from '@assertthat/assertthat-bdd'
 
 * For downloading feature files:
 
+Using Basic auth
+
 ```js
 const assertThat = require('assertthat-bdd');
 
@@ -70,11 +72,26 @@ assertThat.downloadFeatures({
 });
 ```
 
+Using Jira API token (more info can be found here [Using personal access tokens](https://confluence.atlassian.com/enterprise/using-personal-access-tokens-1026032365.html))
+
+```js
+const assertThat = require('assertthat-bdd');
+
+assertThat.downloadFeatures({
+  "projectId": PROJECT_ID,
+  "token": "ASSERTTHAT_API_TOKEN",
+  "jiraServerUrl": "Jira server URL." //Omit if using Jira Cloud
+}, function() {
+  // some optional callback code
+});
+```
+
 Available parameters:
 
 ```
   -a, --accessKey [ASSERTTHAT_ACCESS_KEY]   Access key
   -s, --secretKey [ASSERTTHAT_SECRET_KEY]   Secret key
+  -t, --token [ASSERTTHAT_API_TOKEN]        Jira API token (Server and DC only)
   -u, --jiraServerUrl [URL]                 Jira server URL e.g https://mycompanyjira.com
   -i, --projectId <ID>                      Jira project id
   -m, --mode <mode>                         Features to download (default: "automated")
@@ -87,6 +104,8 @@ Available parameters:
 
 * For uploading reports:
 
+Using Basic auth
+
 ```js
 const assertThat = require('assertthat-bdd');
 
@@ -100,11 +119,26 @@ assertThat.uploadReports({
 });
 ```
 
+Using Jira API token (more info can be found here [Using personal access tokens](https://confluence.atlassian.com/enterprise/using-personal-access-tokens-1026032365.html))
+
+```js
+const assertThat = require('assertthat-bdd');
+
+assertThat.uploadReports({
+  "projectId": PROJECT_ID,
+  "token": "ASSERTTHAT_API_TOKEN",
+  "jiraServerUrl": "Jira server URL." //Omit if using Jira Cloud
+}, function() {
+   // some optional callback code
+});
+```
+
 Available parameters:
 
 ```
   -a, --accessKey [ASSERTTHAT_ACCESS_KEY]   Access key
   -s, --secretKey [ASSERTTHAT_SECRET_KEY]   Secret key
+  -t, --token [ASSERTTHAT_API_TOKEN]        Jira API token (Server and DC only)
   -i, --projectId <ID>                      Jira project id
   -j, --jsonReportFolder [FOLDER PATH]      Cucumber json files folder
   -n, --runName [NAME]                      Test run name

bin/cli.js

@@ -9,6 +9,7 @@ program
   .version('1.2.0')
   .option('-a, --accessKey [ASSERTTHAT_ACCESS_KEY]', 'Access key')
   .option('-s, --secretKey [ASSERTTHAT_SECRET_KEY]', 'Secret key')
+  .option('-t, --token [ASSERTTHAT_API_TOKEN]', 'Jira API token (Server and DC only)')
   .option('-u, --jiraServerUrl [URL]', 'Jira server URL e.g https://mycompanyjira.com')
   .option('-f, --features', 'Download features')
   .option('-r, --report', 'Upload report')
@@ -20,15 +21,17 @@ program
   .option('-d, --metadata [FILE PATH]', 'Metadata json file path')
   .option('-o, --outputFolder [FOLDER PATH]', 'Jira project id')
   .option('-q, --jql [JQL]', 'JQL filter for features download and report upload')
-  .option('-t, --jsonReportIncludePattern [PATTERN]', 'Pattern for json file names')
+  .option('-p, --jsonReportIncludePattern [PATTERN]', 'Pattern for json file names')
   .option('-x, --proxyURI [URI]', 'Proxy URI')
   .option('-b, --numbered [true|false]', 'Append number to feature name on download');
 
 program.on('--help', function(){
   console.log('')
   console.log('Examples:');
   console.log('  $ assertthat-bdd -f -i 10001 -a "access_key" -s "secret_key"');
+  console.log('  $ assertthat-bdd -f -i 10001 -t JIRA_API_TOKEN');
   console.log('  $ assertthat-bdd -r -i 10001 -a "access_key" -s "secret_key"');
+  console.log('  $ assertthat-bdd -r -i 10001 -t JIRA_API_TOKEN');
   console.log('  $ assertthat-bdd -h');
 });
 
@@ -38,6 +41,7 @@ const settings = {
     projectId: program.projectId || process.env.ASSERTTHAT_PROJECT_ID,
     accessKey: program.accessKey || process.env.ASSERTTHAT_ACCESS_KEY,
     secretKey: program.secretKey || process.env.ASSERTTHAT_SECRET_KEY,
+    token: program.token || process.env.ASSERTTHAT_API_TOKEN,
     jiraServerUrl: program.jiraServerUrl,
     jsonReportFolder: program.jsonReportFolder || './reports/',
     mode: program.mode,
@@ -57,20 +61,15 @@ function make_red(txt) {
 }
 
 if(program.features){
-    if(!settings.projectId || !settings.accessKey || !settings.secretKey){
+    if(!settings.projectId || (!settings.token && (!settings.accessKey || !settings.secretKey))){
         if(!program.projectId){
             console.log('');
             console.log(make_red('projectId (-i) option is required'));
             console.log('');
         }
-        if(!program.accessKey){
+        if(!settings.token && (!settings.accessKey || !settings.secretKey)){
             console.log('');
-            console.log(make_red('accessKey (-a) option is required'));
-            console.log('');
-        }
-        if(!program.secretKey){
-            console.log('');
-            console.log(make_red('secretKey (-s) option is required'));
+            console.log(make_red('accessKey (-a) with secretKey (-s) or Jira API token (-t) option is required'));
             console.log('');
         }
         program.outputHelp(make_red);
@@ -80,20 +79,15 @@ if(program.features){
 }
 
 if(program.report){
-if(!settings.projectId || !settings.accessKey || !settings.secretKey){
+if(!settings.projectId || (!settings.token && (!settings.accessKey || !settings.secretKey))){
         if(!program.projectId){
             console.log('');
             console.log(make_red('projectId (-i) option is required'));
             console.log('');
         }
-        if(!program.accessKey){
-            console.log('');
-            console.log(make_red('accessKey (-a) option is required'));
-            console.log('');
-        }
-        if(!program.secretKey){
+        if(!settings.token && (!settings.accessKey || !settings.secretKey)){
             console.log('');
-            console.log(make_red('secretKey (-s) option is required'));
+            console.log(make_red('accessKey (-a) with secretKey (-s) or Jira API token (-t) option is required'));
             console.log('');
         }
         program.outputHelp(make_red);

lib/assertthat-bdd.js

@@ -32,13 +32,18 @@ const downloadFeatures = function(settings, callback) {
 
       req.query({ numbered: settings.numbered })
 
-      req.auth(settings.accessKey, settings.secretKey)
-      .on('error', function(error) {
+      if(settings.token){
+        req.set({'Authorization': 'Bearer ' + settings.token})
+      }else{
+        req.auth(settings.accessKey, settings.secretKey);
+      }
+
+      req.on('error', function(error) {
         console.log(error);
       })
       .on('response', function(response) {
         if (response.status !== 200) {
-            console.log("Failed to download feature files: " + response.text);
+            console.log("Failed to download feature files: " + response.error);
             req.abort();
         }
       })
@@ -87,8 +92,12 @@ async function sendReport(settings, filename, runId){
     if (fs.existsSync(settings.metadata)){
        metadata = fs.readFileSync(settings.metadata, 'utf8');
     }
+    if(settings.token){
+      req.set({'Authorization': 'Bearer ' + settings.token})
+    }else{
+      req.auth(settings.accessKey, settings.secretKey);
+    }
     const response = req
-        .auth(settings.accessKey, settings.secretKey)
         .set('Content-Type', 'application/octet-stream')
         .field('projectId', settings.projectId)
         .field('runName', settings.runName)

typings/index.d.ts

@@ -1,7 +1,8 @@
 declare module '@assertthat/assertthat-bdd' {
     export type Parameters = {
-      accessKey: string;
-      secretKey: string;
+      accessKey?: string;
+      secretKey?: string;
+      token?: string;
       jiraServerUrl?: string;
       projectId: string;
       mode?: string;