Merge pull request #2 from calibreapp/overall-metrics

Add overall metrics for processing

.github/main.workflow

@@ -0,0 +1,17 @@
+workflow "Test" {
+  on = "push"
+  resolves = ["npm test"]
+}
+
+action "npm ci" {
+  uses = "./"
+  runs = "npm"
+  args = "ci"
+}
+
+action "npm test" {
+  needs = "npm ci"
+  uses = "./"
+  runs = "npm"
+  args = "test"
+}

Dockerfile

@@ -87,5 +87,6 @@ RUN npm ci
 # copy in src
 COPY LICENSE README.md entrypoint.js /usr/local/src/image-actions/
 COPY src/ /usr/local/src/image-actions/src/
+COPY __tests__/ /usr/local/src/image-actions/__tests__/
 
 ENTRYPOINT ["/usr/local/src/image-actions/entrypoint.js"]

README.md

@@ -1,10 +1,10 @@
 # Image actions
 
-Image actions will automatically compress jpeg and png images in Github Pull Requests.
+Image actions will automatically compress jpeg and png images in GitHub Pull Requests.
 
 - **Compression is fast, efficient and lossless**
 - Uses mozjpeg + libvips, the best image compression available
-- Runs in Github Actions **for free**
+- Runs in GitHub Actions **for free**
 
 ![Preview of image-actions pull request comment](https://user-images.githubusercontent.com/924/62024579-e1470d00-b218-11e9-8655-693ea42ba0f7.png)
 
@@ -29,5 +29,5 @@ This action requires a `GITHUB_TOKEN` so that it has access to commit the optimi
 
 ## Links and resources
 
-- [View calibre/image-actions on the Github Marketplace](https://github.com/marketplace/actions/image-actions)
+- [View calibre/image-actions on the GitHub Marketplace](https://github.com/marketplace/actions/image-actions)
 - [Mozjpeg](https://github.com/mozilla/mozjpeg)

__tests__/github-markdown_test.js

@@ -0,0 +1,56 @@
+const results = {
+  images: [
+    {
+      name: "icon.png",
+      path: "__tests__/test-images/icon.png",
+      beforeStats: 8914,
+      afterStats: 3361,
+      percentChange: -62.29526587390622,
+      compressionWasSignificant: true
+    },
+    {
+      name: "optimised-image.png",
+      path: "__tests__/test-images/optimised-image.png",
+      beforeStats: 3361,
+      afterStats: 3361,
+      percentChange: 0,
+      compressionWasSignificant: false
+    },
+    {
+      name: "roo.jpg",
+      path: "__tests__/test-images/roo.jpg",
+      beforeStats: 468895,
+      afterStats: 485742,
+      percentChange: 3.592915258213452,
+      compressionWasSignificant: false
+    }
+  ],
+  metrics: {
+    bytesSaved: 5553,
+    percentChange: -62.29526587390622
+  }
+};
+
+const markdown = require("../src/github-markdown");
+
+const referenceMarkdown = `
+Images automagically compressed by [Calibre](https://calibreapp.com)'s [image-actions](https://github.com/marketplace/actions/image-actions) ✨
+
+Compression reduced images by 62.3%, saving 5.42 KB
+
+| Filename | Before | After | Improvement |
+| --- | --- | --- | --- |
+| \`icon.png\` | 8.71 KB | 3.28 KB | -62.3% |
+
+
+<details>
+<summary>Some images were already optimised</summary>
+
+* \`optimised-image.png\`
+* \`roo.jpg\`
+</details>`;
+
+test("writes the markdown", async () => {
+  const markdownResult = await markdown(results);
+  expect(markdownResult).toEqual(referenceMarkdown);
+});

__tests__/image-processing_test.js

@@ -0,0 +1,68 @@
+const path = require("path");
+const fs = require("fs").promises;
+
+const EXAMPLE_IMAGES_DIR = `${process.cwd()}/__tests__/example-images`;
+const TMP_TEST_IMAGES_DIR = `${process.cwd()}/__tests__/test-images`;
+
+const EXAMPLE_IMAGES = ["roo.jpg", "icon.png", "optimised-image.png"];
+
+beforeEach(async () => {
+  await fs.mkdir(TMP_TEST_IMAGES_DIR);
+
+  // Copy in reference images for stats
+  for await (const image of EXAMPLE_IMAGES) {
+    await fs.copyFile(
+      path.join(EXAMPLE_IMAGES_DIR, image),
+      path.join(TMP_TEST_IMAGES_DIR, image)
+    );
+  }
+});
+
+afterEach(async () => {
+  for await (const image of EXAMPLE_IMAGES) {
+    await fs.unlink(path.join(TMP_TEST_IMAGES_DIR, image));
+  }
+  await fs.rmdir(TMP_TEST_IMAGES_DIR);
+});
+
+const imageProcessing = require("../src/image-processing");
+
+test("returns metrics for images", async () => {
+  const results = await imageProcessing();
+
+  expect(results.metrics).toEqual({
+    bytesSaved: 5553,
+    percentChange: -62.29526587390622
+  });
+});
+
+test("returns images with stats", async () => {
+  const results = await imageProcessing();
+
+  expect(results.images).toEqual([
+    {
+      afterStats: 3361,
+      beforeStats: 8914,
+      compressionWasSignificant: true,
+      name: "icon.png",
+      path: "__tests__/test-images/icon.png",
+      percentChange: -62.29526587390622
+    },
+    {
+      afterStats: 3361,
+      beforeStats: 3361,
+      compressionWasSignificant: false,
+      name: "optimised-image.png",
+      path: "__tests__/test-images/optimised-image.png",
+      percentChange: 0
+    },
+    {
+      afterStats: 485759,
+      beforeStats: 468895,
+      compressionWasSignificant: false,
+      name: "roo.jpg",
+      path: "__tests__/test-images/roo.jpg",
+      percentChange: 3.596540803378147
+    }
+  ]);
+});

entrypoint.js

@@ -17,11 +17,6 @@ if (!GITHUB_TOKEN) {
   process.exit(1);
 }
 
-if (!REPO_DIRECTORY) {
-  console.log("There is no REPO_DIRECTORY set");
-  process.exit(1);
-}
-
 const main = async () => {
   // Bail out if the event that executed the action wasn’t a pull_request
   if (GITHUB_EVENT_NAME !== "pull_request") {
@@ -59,7 +54,9 @@ const main = async () => {
   const markdown = await generateMarkdownReport(results);
 
   console.log("->> Committing files…");
-  const optimisedImages = results.filter(img => img.compressionWasSignificant);
+  const optimisedImages = results.images.filter(
+    img => img.compressionWasSignificant
+  );
   await createCommit(optimisedImages);
 
   console.log("->> Leaving comment on PR…");