DEV-297 - Updated integration tests to be more automatic given env variables (#28)

* DEV-297 - Updated integration tests to be more automatic given env variables

* code clean up and added TEST.md

* lint

* addressed comments

* addressed comments, changed bogus emails to @example.com

* address comments added a way to delete the test orgs after a test

Co-authored-by: Alan Canedo Zarazua <[email protected]>

Author: acanedo

.env.example

@@ -0,0 +1,11 @@
+# `.env.example` DO NOT use this file, rather copy into a new file called `.env` and fill in your actual values and secrets.
+# Never commit an `.env` file to a repository.
+
+ALGORITHMIA_API_ADDRESS=anAlgorithmiaAPIAddress
+ALGORITHMIA_DEFAULT_API_KEY=yourAlgorithmiaAPIKeyHashSecret
+
+# Variables for testing
+ALGORITHMIA_TEST_ADMIN_API_KEY=anAlgorithmiaAdminAPIKeySecret
+ALGORITHMIA_TEST_API_ADDRESS=aTestingEnvironmentAlgorithmiaAPIAddress
+ALGORITHMIA_TEST_DEFAULT_API_KEY=yourAlgorithmiaAPIkeyHashSecret
+ALGORITHMIA_TEST_USERNAME=yourAlgorithmiaUserName

.gitignore

@@ -1,3 +1,3 @@
 node_modules/
-
+.env
 /lib

.gitlab-ci.yml

@@ -13,5 +13,5 @@ test:
   script:
   - npm install typescript -g && npm install @types/node
   - npx tsc
-  - if [ -z $ALGORITHMIA_DEFAULT_API_KEY ]; then echo "Algorithmia API key not defined"; exit 1; fi
+  - if [ -z $ALGORITHMIA_TEST_DEFAULT_API_KEY ]; then echo "Algorithmia API key not defined"; exit 1; fi
   - npm test --detectOpenHandles

NahDawg.txt

@@ -14,7 +14,16 @@ Install it for your project by adding `algorithmia` to your package.json:
 npm install --save algorithmia
 ```
 
-Then instantiate an Algorithmia client using your API key:
+Set runtime environment variables by creating `.env` file in the root directory with the following keys
+
+---
+
+   |Name|Value|Purpose|
+   |-|-|-|
+   |ALGORITHMIA_API_ADDRESS|`<key for Algorithmia api url>`|Optional, will default to https://api.algorithmia.com|
+   |ALGORITHMIA_DEFAULT_API_KEY|`<secret key to run Algorithmia api>`|Required for algorithmia client|
+
+Then instantiate an Algorithmia client using your API key environment variables:
 
 ```javascript
 const algorithmia = require('algorithmia');

README.md

@@ -14,7 +14,7 @@
     "compile:watch": "tsc -w",
     "prepare": "npm run compile",
     "prepublishOnly": "npm test --detectOpenHandles",
-    "lint": "eslint ./src/**/*.{js,ts} --quiet",
+    "lint": "eslint ./src/**/*.{js,ts} ./test/**/*.{js,ts,test.ts,test.js} --quiet",
     "lint:fix": "npm run lint -- --fix",
     "test": "jest"
   },
@@ -33,6 +33,7 @@
     "@typescript-eslint/eslint-plugin": "^4.22.1",
     "@typescript-eslint/parser": "^4.22.1",
     "babel-jest": "^26.6.3",
+    "dotenv": "^10.0.0",
     "eslint": "^7.26.0",
     "eslint-config-prettier": "^7.2.0",
     "eslint-plugin-prettier": "^3.4.0",

package-lock.json

@@ -33,25 +33,6 @@ class Algorithm {
     this.self_link = self_link;
     this.resource_type = resource_type;
   }
-
-  //for testing
-  createTestAlgo() {
-    const requestObject = {
-      details: {
-        label: 'My First Algorithm',
-      },
-      name: 'my_first_algorithm',
-      settings: {
-        environment: 'cpu',
-        language: 'python3-1',
-        license: 'apl',
-        network_access: 'full',
-        pipeline_enabled: true,
-        source_visibility: 'closed',
-      },
-    };
-    return requestObject;
-  }
 }
 
 class Details {

package.json

@@ -4,6 +4,8 @@ import type { Input } from './ContentTypeHelper';
 import { DataFile, DataDir } from './Data';
 import { URLSearchParams } from 'url';
 import { Organization, OrgType, OrgTypes } from './Algorithm';
+import dotenv from 'dotenv';
+dotenv.config();
 
 class AlgorithmiaClient {
   private defaultApiAddress = 'https://api.algorithmia.com';
@@ -23,16 +25,15 @@ class AlgorithmiaClient {
       apiAddress ||
       process.env.ALGORITHMIA_API_ADDRESS ||
       this.defaultApiAddress;
-    this.key = key || process.env.ALGORITHMIA_API_KEY || '';
+    this.key = key || process.env.ALGORITHMIA_DEFAULT_API_KEY || '';
     if (key) {
       if (key.startsWith('Simple ')) {
         this.key = key;
       } else {
         this.key = 'Simple ' + key;
       }
-    } else {
-      this.key = '';
     }
+
     this.httpClient = new HttpClient(this.key);
   }
 
@@ -60,6 +61,41 @@ class AlgorithmiaClient {
     );
   }
 
+  /**
+   * Get an Algorithm build object from this client
+   * @param userName the algorithmia user name
+   * @param algoName the name of the algorithm
+   * @return an Algorithm build object for the specified algorithm
+   */
+  buildAlgo(userName: string, algoName: string) {
+    return this.httpClient.post(
+      `${this.apiAddress}${this.algorithmsPrefix}/${userName}/${algoName}/compile`,
+      {},
+      'application/json'
+    );
+  }
+
+  /**
+   * Get an Algorithm published object from this client
+   * @param userName the algorithmia user name
+   * @param algoName the name of the algorithm
+   * @return an Algorithm published object for the specified algorithm
+   */
+  publishAlgo(userName: string, algoName: string) {
+    return this.httpClient.post(
+      `${this.apiAddress}${this.algorithmsPrefix}/${userName}/${algoName}/version`,
+      {
+        settings: {
+          algorithm_callability: 'private',
+          insights_enabled: false,
+          royalty_microcredits: 0,
+        },
+        version_info: { version_type: 'revision' },
+      },
+      'application/json'
+    );
+  }
+
   /**
    * List algorithm versions from this client
    * @param userName the users Algorithmia user name
@@ -130,8 +166,9 @@ class AlgorithmiaClient {
    * @return a BuildLogs object for the specified algorithm
    */
   getAlgoBuildLogs(userName: string, algoName: string, buildId: string) {
-    const path = `${this.algorithmsPrefix}/${userName}/${algoName}/builds/${buildId}/logs`;
-    return this.httpClient.get(`${this.apiAddress}${path}`);
+    return this.httpClient.get(
+      `${this.apiAddress}${this.algorithmsPrefix}/${userName}/${algoName}/builds/${buildId}/logs`
+    );
   }
 
   /**
@@ -239,6 +276,17 @@ class AlgorithmiaClient {
     );
   }
 
+  /**
+   * Delete an organization from this client
+   * @param orgName the organization name
+   * @return an empty response
+   */
+  deleteOrganization(orgName: string) {
+    return this.httpClient.delete(
+      `${this.apiAddress}${this.organizationsPrefix}/${orgName}`
+    );
+  }
+
   clone(obj: Input) {
     return JSON.parse(JSON.stringify(obj));
   }

src/Algorithm.ts

@@ -1,5 +1,5 @@
 export interface Json {
-  [key: string]: number | string | null | Json;
+  [key: string]: number | string | null | Json | boolean;
 }
 
 export type Input = Json | string | Buffer;