feat: add more robust openjsf test

Author: anonrig

.gitignore

@@ -1,4 +1,5 @@
 node_modules
 package-lock.json
 test/fixture/output.md
-test/openjsf/tmp.md
+test/openjsf/tmp.md
+test/**/*.rej

README.md

@@ -23,7 +23,7 @@ jobs:
         with:
           persist-credentials: false
       - name: Start Patch
-        uses: pkgjs/patch-my-code-of-conduct@v1.0.3
+        uses: pkgjs/patch-my-code-of-conduct@v1.2.0
         with:
           base_url: './BASE.md'
           patch_file_path: './patch'
@@ -37,3 +37,20 @@ jobs:
           commit-message: 'doc: update Code of Conduct'
           title: 'doc: update Code of Conduct'
 ```
+
+## Useful Information
+
+### Generate patch file
+
+- Generate a `premable+template.md`
+- Generate a `original-expected.md` file
+
+```bash
+diff -Naur preamble+template.md original-expected.md > patch
+```
+
+### Running patching script
+
+```
+patch -i patch preamble+template.md -o expected.md --no-backup-if-mismatch
+```

lib/index.js

@@ -9,5 +9,3 @@ const output_path = core.getInput('output_file_path');
 apply_patch(base_url, template_url, patch_path, output_path)
   .then(() => core.setOutput('state', 'success'))
   .catch(error => core.setFailed(error))
-
-

lib/runner.js

@@ -1,27 +1,30 @@
 const fs = require('node:fs')
 const { execSync } = require('node:child_process')
-const { fetch } = require('undici')
+const { fetch } = require('undici');
+const { randomUUID } = require('node:crypto');
 
-async function apply_patch(base_url, template_url, patch_path, output_path) {
+async function apply_patch(base_url, template_url, patch_path, output_path, tmp_file_path) {
   if (!fs.existsSync(base_url)) {
     throw new Error(`base_url (${base_url}) does not exist`)
   }
   const base_text = fs.readFileSync(base_url, 'utf-8');
   const template_response = await fetch(template_url);
+  tmp_file_path ??= `/tmp/coc-${randomUUID()}.md`;
 
   if (template_response.status !== 200 && template_response.status !== 201) {
     throw new Error(`template response got ${template_response.status} status code. expected 200 or 201.`)
   }
   const template_text = await template_response.text();
 
-  const output_text = `${base_text}${template_text}`;
-  fs.writeFileSync(output_path, output_text);
+  // Make sure that there is a new line at the end.
+  const output_text = `${base_text}\n${template_text.trim()}\n`;
+  fs.writeFileSync(tmp_file_path, output_text);
 
   if (!fs.existsSync(patch_path)) {
     throw new Error(`patch_path (${patch_path}) does not exist`)
   }
 
-  await execSync(`patch -i ${patch_path} ${output_path} -R --no-backup-if-mismatch`);
+  await execSync(`patch -i ${patch_path} ${tmp_file_path} -o ${output_path} --no-backup-if-mismatch`);
 
   const original_file = output_path + '.orig'
   // Delete `output.md.orig` file, if exists

test/apply.test.ts

@@ -0,0 +1,23 @@
+import { assert, beforeEach, test } from 'vitest';
+import path from 'node:path'
+import fs from 'node:fs'
+import { apply_patch } from '../lib/runner.js'
+
+const template = 'https://www.contributor-covenant.org/version/2/1/code_of_conduct/code_of_conduct.md'
+const preamble = path.join(__dirname, './openjsf/preamble.md')
+const patch = path.join(__dirname, './openjsf/patch')
+const expected = path.join(__dirname, './openjsf/expected.md')
+const original_expected = path.join(__dirname, './openjsf/original-expected.md')
+
+const tmp_file_path = path.join(__dirname, './openjsf/tmp.md')
+
+beforeEach(() => {
+  fs.copyFileSync(original_expected, expected)
+  fs.rmSync(tmp_file_path, { force: true })
+})
+
+test('should create the exact result with expected', async () => {
+  await apply_patch(preamble, template, patch, expected, tmp_file_path);
+
+  assert.deepEqual(fs.readFileSync(expected, 'utf-8'), fs.readFileSync(original_expected, 'utf-8'))
+})