Merge pull request #886 from blikblum/improve-tests

Improve tests structure

    Load src files directly allowing to test without build step and test isolated classes
    Separate tests into two categories: unit and integration
    Allow to use ES modules in tests
    Ensure test output is the same across different runs / systems

Author: blikblum

.babelrc

@@ -0,0 +1,8 @@
+{
+  "presets": [["env", {"modules": false, "targets": {"node": "6.10"}}]],
+  "env": {
+    "test": {
+      "presets": [["env", {"targets": {"node": "6.10"}}]]
+    }
+  }
+}

lib/font/standard.js

@@ -4,20 +4,20 @@ import fs from 'fs';
 
 // This insanity is so bundlers can inline the font files
 const STANDARD_FONTS = {
-  "Courier"() { return fs.readFileSync(__dirname + "/font/data/Courier.afm", 'utf8'); },
-  "Courier-Bold"() { return fs.readFileSync(__dirname + "/font/data/Courier-Bold.afm", 'utf8'); },
-  "Courier-Oblique"() { return fs.readFileSync(__dirname + "/font/data/Courier-Oblique.afm", 'utf8'); },
-  "Courier-BoldOblique"() { return fs.readFileSync(__dirname + "/font/data/Courier-BoldOblique.afm", 'utf8'); },
-  "Helvetica"() { return fs.readFileSync(__dirname + "/font/data/Helvetica.afm", 'utf8'); },
-  "Helvetica-Bold"() { return fs.readFileSync(__dirname + "/font/data/Helvetica-Bold.afm", 'utf8'); },
-  "Helvetica-Oblique"() { return fs.readFileSync(__dirname + "/font/data/Helvetica-Oblique.afm", 'utf8'); },
-  "Helvetica-BoldOblique"() { return fs.readFileSync(__dirname + "/font/data/Helvetica-BoldOblique.afm", 'utf8'); },
-  "Times-Roman"() { return fs.readFileSync(__dirname + "/font/data/Times-Roman.afm", 'utf8'); },
-  "Times-Bold"() { return fs.readFileSync(__dirname + "/font/data/Times-Bold.afm", 'utf8'); },
-  "Times-Italic"() { return fs.readFileSync(__dirname + "/font/data/Times-Italic.afm", 'utf8'); },
-  "Times-BoldItalic"() { return fs.readFileSync(__dirname + "/font/data/Times-BoldItalic.afm", 'utf8'); },
-  "Symbol"() { return fs.readFileSync(__dirname + "/font/data/Symbol.afm", 'utf8'); },
-  "ZapfDingbats"() { return fs.readFileSync(__dirname + "/font/data/ZapfDingbats.afm", 'utf8'); }
+  "Courier"() { return fs.readFileSync(__dirname + "/data/Courier.afm", 'utf8'); },
+  "Courier-Bold"() { return fs.readFileSync(__dirname + "/data/Courier-Bold.afm", 'utf8'); },
+  "Courier-Oblique"() { return fs.readFileSync(__dirname + "/data/Courier-Oblique.afm", 'utf8'); },
+  "Courier-BoldOblique"() { return fs.readFileSync(__dirname + "/data/Courier-BoldOblique.afm", 'utf8'); },
+  "Helvetica"() { return fs.readFileSync(__dirname + "/data/Helvetica.afm", 'utf8'); },
+  "Helvetica-Bold"() { return fs.readFileSync(__dirname + "/data/Helvetica-Bold.afm", 'utf8'); },
+  "Helvetica-Oblique"() { return fs.readFileSync(__dirname + "/data/Helvetica-Oblique.afm", 'utf8'); },
+  "Helvetica-BoldOblique"() { return fs.readFileSync(__dirname + "/data/Helvetica-BoldOblique.afm", 'utf8'); },
+  "Times-Roman"() { return fs.readFileSync(__dirname + "/data/Times-Roman.afm", 'utf8'); },
+  "Times-Bold"() { return fs.readFileSync(__dirname + "/data/Times-Bold.afm", 'utf8'); },
+  "Times-Italic"() { return fs.readFileSync(__dirname + "/data/Times-Italic.afm", 'utf8'); },
+  "Times-BoldItalic"() { return fs.readFileSync(__dirname + "/data/Times-BoldItalic.afm", 'utf8'); },
+  "Symbol"() { return fs.readFileSync(__dirname + "/data/Symbol.afm", 'utf8'); },
+  "ZapfDingbats"() { return fs.readFileSync(__dirname + "/data/ZapfDingbats.afm", 'utf8'); }
 };
 
 class StandardFont extends PDFFont {

package.json

@@ -23,6 +23,7 @@
   "bugs": "http://github.com/devongovett/pdfkit/issues",
   "devDependencies": {
     "babel-core": "^6.26.3",
+    "babel-jest": "^23.6.0",
     "babel-plugin-external-helpers": "^6.22.0",
     "babel-preset-env": "^1.7.0",
     "blob-stream": "^0.1.2",
@@ -54,6 +55,7 @@
     "website": "node docs/generate_website.js",
     "docs": "npm run pdf-guide && npm run website && npm run browser-demo",
     "test": "jest -i",
+    "test:integration": "jest integration/ -i",
     "test:unit": "jest unit/ -i"
   },
   "main": "js/pdfkit.js",

rollup.config.js

@@ -41,7 +41,7 @@ export default [
       }),
       copy({
         files: ['lib/font/data/*.afm'],
-        dest: 'js/font/data'
+        dest: 'js/data'
       }),
       stripFSInterop()
 		]

tests/__snapshots__/fonts.spec.js.snap …gration/__snapshots__/fonts.spec.js.snaptests/__snapshots__/fonts.spec.js.snap renamed to tests/integration/__snapshots__/fonts.spec.js.snap tests/__snapshots__/fonts.spec.js.snap renamed to tests/integration/__snapshots__/fonts.spec.js.snap

@@ -1,7 +1,22 @@
-var PDFDocument = require('../');
+var PDFDocument = require('../../lib/document').default;
+var PDFSecurity = require('../../lib/security').default;
+var CryptoJS = require('crypto-js');
 var path = require('path');
 var fs = require('fs');
 
+// manual mock for PDFSecurity to ensure stored id will be the same accross different systems
+PDFSecurity.generateFileID = () => {
+  return new Buffer('mocked-pdf-id');
+}
+
+PDFSecurity.generateRandomWordArray = (bytes) => {
+  const words = [];
+  for (let i = 0; i < bytes; i++) {
+    words.push(0x00010203);
+  }
+  return new CryptoJS.lib.WordArray.init(words, bytes);
+}
+
 function updatePdf (pdfData, testState, snapshotChanges) {
   const pdfDir = path.join(path.dirname(testState.testPath), '__pdfs__');
   if (!fs.existsSync(pdfDir)) {