Email and slack

.gitignore

@@ -1,5 +1,6 @@
 node_modules
 yarn-error.log
+build
 dist
 .coverage
 /lerna-*

.vscode/settings.json

@@ -0,0 +1,2 @@
+{
+}

CONTRIBUTING.md

@@ -51,3 +51,14 @@ The [`uid` and `gid`](http://www.linfo.org/uid.html) of the user the container i
 ### File Patterns
 
 All parameters used for selecting files (e.g. [`attachments`](email/#attachments), `inputFiles`, `files`) are processed by [micromatch](https://github.com/micromatch/micromatch) which provides wildcard support for selecting multiple files e.g. `gear/*.stl`.
+
+## Container Manifest
+
+A container manifest describes a set of metadata for a container.
+
+```yaml
+image: your-image-title
+author: Author S. Name
+version: 1.0
+schema: https://www.link-to-json-schema.com/schema.json
+```

README.md

@@ -25,4 +25,4 @@ Uploads pipeline outputs to Stemn.
 
 ## Contributing
 
-See [CONTRIBUTING.md](CONTRIBUTING.md)
+See [CONTRIBUTING.md](CONTRIBUTING.md)

containers/cadquery/manifest.json

@@ -0,0 +1,6 @@
+{
+  "author": "stemn",
+  "name": "cadquery",
+  "version": "v1.0.0",
+  "schema": {}
+}

containers/cadquery/package.json

@@ -17,7 +17,10 @@
   },
   "homepage": "https://github.com/stemn/stemn-pipeline-containers#readme",
   "devDependencies": {
+    "@types/nock": "^9.3.0",
+    "mock-fs": "^4.5.0",
+    "nock": "^9.4.1",
+    "prettier": "^1.13.7",
     "version-bump-prompt": "^4.0.0"
-  },
-  "dependencies": {}
+  }
 }

containers/email/manifest.json

@@ -0,0 +1,6 @@
+{
+  "author": "stemn",
+  "name": "email",
+  "version": "v1.0.0",
+  "schema": {}
+}

containers/email/manifest.yml

@@ -0,0 +1,4 @@
+author: Caspian Baska
+title: @stemn/email
+version: 0.0.1
+param-schema: https://raw.githubusercontent.com/stemn/stemn-pipeline-containers/master/packages/email/schema.json

containers/email/package.json

@@ -2,13 +2,15 @@
   "name": "@stemn/email",
   "version": "1.0.0",
   "description": "A container for emailing files and results of a Stemn pipeline.",
+  "main": "dist",
   "scripts": {
     "test": "jest",
     "test:coverage": "yarn test --coverage",
     "lint": "tslint --project tsconfig.json",
-    "build": "yarn build:project && yarn build:container",
+    "build": "yarn build:typescript && yarn build:container",
     "build:container": "docker build -t stemn/email .",
-    "build:project": "tsc",
+    "build:typescript": "tsc",
+    "build:watch": "tsc --watch",
     "release": "bump --tag --push",
     "changelog:verify": "changelog-verify CHANGELOG.md",
     "changelog:version": "version-changelog CHANGELOG.md && git add CHANGELOG.md",
@@ -20,20 +22,38 @@
     "type": "git",
     "url": "git+https://github.com/stemn/stemn-pipeline-containers.git"
   },
-  "author": "Jackson Delahunt",
+  "author": "Caspian Baska",
   "license": "MIT",
-  "bugs": {
-    "url": "https://github.com/stemn/stemn-pipeline-containers/issues"
-  },
-  "homepage": "https://github.com/stemn/stemn-pipeline-containers#readme",
   "dependencies": {
-    "request": "^2.83.0",
-    "request-promise": "^4.2.2"
+    "@stemn/pipeline-logger": "^0.0.2",
+    "@types/axios": "^0.14.0",
+    "@types/micromatch": "^3.1.0",
+    "axios": "^0.18.0",
+    "bluebird": "^3.5.1",
+    "fs-extra": "^6.0.1",
+    "graceful-fs": "^4.1.11",
+    "klaw": "^2.1.1",
+    "klaw-sync": "^4.0.0",
+    "markdown-it": "^8.4.1",
+    "micromatch": "^3.1.10",
+    "request": "^2.83.0"
   },
   "devDependencies": {
-    "@types/node": "^9.4.7",
+    "@types/bluebird": "^3.5.21",
+    "@types/klaw": "^2.1.1",
+    "@types/klaw-sync": "^2.0.0",
+    "@types/markdown-it": "^0.0.4",
+    "@types/mock-fs": "^3.6.30",
+    "@types/nock": "^9.3.0",
+    "@types/node": "^10.5.1",
+    "graceful-fs": "^4.1.11",
+    "jest": "^23.2.0",
+    "mock-fs": "^4.5.0",
+    "nock": "^9.4.1",
     "nodemon": "^1.14.12",
-    "typescript": "^2.7.2",
+    "prettier": "^1.13.7",
+    "ts-jest": "^23.0.0",
+    "typescript": "^2.9.2",
     "version-bump-prompt": "^4.0.0"
   }
 }

containers/email/schema.json

@@ -0,0 +1,25 @@
+{
+    "$schema": "http://json-schema.org/draft-06/schema#",
+    "properties": {
+        "attachments": {
+            "items": {
+                "type": "string"
+            },
+            "type": "array"
+        },
+        "body": {
+            "type": "markdown"
+        },
+        "subject": {
+            "type": "string"
+        },
+        "to": {
+            "items": {
+                "type": "string"
+            },
+            "type": "array"
+        }
+    },
+    "type": "object"
+}
+

containers/email/scripts/sendEmail.ts

@@ -1,3 +1,3 @@
-import { sendEmail } from "../src";
+import { sendEmail } from '../src';
 
-void sendEmail()
+void sendEmail();

containers/email/src/__tests__/email.test.ts

@@ -1,5 +1,137 @@
-import { sendEmail } from "../index";
+const mockFs = require('mock-fs');
+import * as fs from 'fs-extra';
+import * as Markdown from 'markdown-it';
+import * as nock from 'nock';
 
-it('works', () => {
-  expect(sendEmail).toBeInstanceOf(Function)
-})
+const { sendEmail } = require('../sendEmail');
+
+// Mocked file objects
+const mockedFiles: { [key: string]: string | Buffer } = {
+  '/pipeline/test.txt': 'foo bar baz',
+  '/pipeline/girtbysea.txt': 'bar',
+  '/pipeline/images/a.png': Buffer.from([8, 6, 7, 5, 3, 0, 9]),
+};
+
+jest.mock('fs-extra');
+fs.stat.mockImplementation((filename: string) => mockedFiles[filename].length);
+
+const markdown = Markdown({
+  html: true,
+  linkify: true,
+  typographer: true,
+});
+
+const emails = ['[email protected]'];
+const emailContent = '# hey\n\n from the stemn pipeline';
+const sendGridAuth = 'D3ADB33F';
+
+beforeAll(() => {
+  Object.assign(process.env, {
+    STEMN_PIPELINE_PARAMS_TO: JSON.stringify(emails),
+    STEMN_PIPELINE_PARAMS_BODY: emailContent,
+    STEMN_SENDGRID_AUTH: sendGridAuth,
+  });
+
+  nock.disableNetConnect();
+});
+
+afterAll(() => {
+  nock.enableNetConnect();
+});
+
+beforeEach(() => {
+  mockFs(mockedFiles);
+});
+
+afterEach(() => {
+  mockFs.restore();
+});
+
+describe('sending an email with no attachments', () => {
+  let requestBody: any;
+  let response: any;
+
+  beforeAll(async () => {
+    nock('https://api.sendgrid.com')
+      .defaultReplyHeaders({ 'access-control-allow-origin': '*' })
+      .post('/v3/mail/send')
+      .reply(200, (uri: string, body: string) => {
+        requestBody = JSON.parse(body);
+      });
+
+    response = await sendEmail();
+  });
+
+  it('succeeds with 200', () => expect(response.status).toBe(200));
+  it('requests with correct auth header', () => expect(requestBody.headers.Authorization).toBe(`Bearer ${ sendGridAuth }`));
+  it('sends an email with no attachments', () => expect(requestBody.data.attachments).toEqual([]));
+  it('correctly renders markdown', () => {
+
+    const expected = [{
+      type: 'text/html',
+      value: markdown.render(emailContent),
+    }, {
+      type: 'text/plaintext',
+      value: emailContent,
+    }];
+
+    expect(requestBody.data.content).toEqual(expected);
+  });
+});
+
+describe('sending email with attachment', async () => {
+  let requestBody: any;
+
+  beforeAll(async () => {
+    Object.assign(process.env, {
+      STEMN_PIPELINE_PARAMS_ATTACHMENTS: JSON.stringify(['*.png']),
+    });
+
+    nock('https://api.sendgrid.com')
+      .defaultReplyHeaders({ 'access-control-allow-origin': '*' })
+      .post('/v3/mail/send')
+      .reply(200, (uri: string, body: string) => {
+        requestBody = JSON.parse(body);
+      });
+
+    return sendEmail();
+  });
+
+  afterAll(() => {
+    delete process.env.STEMN_PIPELINE_PARAMS_ATTACHMENTS;
+  });
+
+  it('correctly encodes attachments', () => {
+    const convertToExpected = (obj: any, { filename, content }: { filename: string; content: string }) => {
+      const env: any = {};
+      env[filename] = Buffer.from(content, 'base64').toString('ascii');
+      return { ...obj, ...env };
+    };
+
+    const attachments = requestBody.data.attachments.reduce(convertToExpected, {});
+    return expect(attachments).toMatchObject(mockedFiles);
+  });
+});
+
+describe('sending email with attachments that exceed limit', () => {
+  beforeAll(() => {
+    Object.assign(process.env, {
+      STEMN_PIPELINE_PARAMS_ATTACHMENTS: JSON.stringify(['*.txt']),
+      STEMN_MAX_ATTACHMENTS: 0,
+    });
+
+    nock('https://api.sendgrid.com')
+      .defaultReplyHeaders({ 'access-control-allow-origin': '*' })
+      .post('/v3/mail/send')
+      .reply(200);
+  });
+
+  afterAll(() => {
+    delete process.env.STEMN_PIPELINE_PARAMS_ATTACHMENTS;
+    delete process.env.STEMN_MAX_ATTACHMENTS;
+  });
+
+  it('fails when attachment limit exceeded', () => {
+    return expect(sendEmail).toThrow(/Attachment limit exceeded/);
+  });
+});

containers/email/src/index.ts

@@ -1,21 +1 @@
-const {
-  STEMN_PIPELINE_ID,
-  STEMN_PIPELINE_PARAMS_TO,
-  STEMN_PIPELINE_PARAMS_SUBJECT,
-  STEMN_PIPELINE_PARAMS_BODY,
-  STEMN_PIPELINE_PARAMS_ATTACHMENTS,
-  // STEMN_PIPELINE_ROOT,
-  // STEMN_PIPELINE_TMP,
-  STEMN_PIPELINE_TOKEN,
-} = process.env;
-
-export function sendEmail () {
-  console.log({ // tslint:disable-line
-    STEMN_PIPELINE_ID,
-    STEMN_PIPELINE_PARAMS_TO,
-    STEMN_PIPELINE_PARAMS_SUBJECT,
-    STEMN_PIPELINE_PARAMS_BODY,
-    STEMN_PIPELINE_PARAMS_ATTACHMENTS,
-    STEMN_PIPELINE_TOKEN,
-  });
-};
+export { sendEmail } from './sendEmail';