chore(doclint): move doclint tests expectations into test folders (#932)

This makes for much easier work with doclint tests.
puppeteer · Oct 2, 2017 · 41fd4b5 · 41fd4b5
1 parent f9640a5
commit 41fd4b5
Show file tree

Hide file tree

Showing 12 changed files with 13 additions and 11 deletions.
diff --git a/test/golden-utils.js b/test/golden-utils.js
@@ -85,6 +85,8 @@ function compareText(actual, expectedBuffer) {
  * @return {!{pass: boolean, message: (undefined|string)}}
  */
 function compare(goldenPath, outputPath, actual, goldenName) {
+  goldenPath = path.normalize(goldenPath);
+  outputPath = path.normalize(outputPath);
   const expectedPath = path.join(goldenPath, goldenName);
   const actualPath = path.join(outputPath, goldenName);
 
@@ -110,9 +112,13 @@ function compare(goldenPath, outputPath, actual, goldenName) {
   if (!result)
     return { pass: true };
   ensureOutputDir();
-  fs.writeFileSync(actualPath, actual);
-  // Copy expected to the output/ folder for convenience.
-  fs.writeFileSync(addSuffix(actualPath, '-expected'), expected);
+  if (goldenPath === outputPath) {
+    fs.writeFileSync(addSuffix(actualPath, '-actual'), actual);
+  } else {
+    fs.writeFileSync(actualPath, actual);
+    // Copy expected to the output/ folder for convenience.
+    fs.writeFileSync(addSuffix(actualPath, '-expected'), expected);
+  }
   if (result.diff) {
     const diffPath = addSuffix(actualPath, '-diff', result.diffExtension);
     fs.writeFileSync(diffPath, result.diff);

diff --git a/utils/doclint/check_public_api/test/.gitignore b/utils/doclint/check_public_api/test/.gitignore
@@ -0,0 +1,2 @@
+result-actual.txt
+result-diff.html
diff --git a/.../test/01-class-errors/01-class-errors.txt → ...ublic_api/test/01-class-errors/result.txt b/.../test/01-class-errors/01-class-errors.txt → ...ublic_api/test/01-class-errors/result.txt
diff --git a/...blic_api/test/golden/02-method-errors.txt → ...blic_api/test/02-method-errors/result.txt b/...blic_api/test/golden/02-method-errors.txt → ...blic_api/test/02-method-errors/result.txt
diff --git a/...ic_api/test/golden/03-property-errors.txt → ...ic_api/test/03-property-errors/result.txt b/...ic_api/test/golden/03-property-errors.txt → ...ic_api/test/03-property-errors/result.txt
diff --git a/...blic_api/test/golden/04-bad-arguments.txt → ...blic_api/test/04-bad-arguments/result.txt b/...blic_api/test/golden/04-bad-arguments.txt → ...blic_api/test/04-bad-arguments/result.txt
diff --git a/...ublic_api/test/golden/05-event-errors.txt → ...ublic_api/test/05-event-errors/result.txt b/...ublic_api/test/golden/05-event-errors.txt → ...ublic_api/test/05-event-errors/result.txt
diff --git a/..._public_api/test/golden/06-duplicates.txt → ..._public_api/test/06-duplicates/result.txt b/..._public_api/test/golden/06-duplicates.txt → ..._public_api/test/06-duplicates/result.txt
diff --git a/...eck_public_api/test/golden/07-sorting.txt → ...eck_public_api/test/07-sorting/result.txt b/...eck_public_api/test/golden/07-sorting.txt → ...eck_public_api/test/07-sorting/result.txt
diff --git a/...heck_public_api/test/golden/08-return.txt → ...heck_public_api/test/08-return/result.txt b/...heck_public_api/test/golden/08-return.txt → ...heck_public_api/test/08-return/result.txt
diff --git a/utils/doclint/check_public_api/test/golden/01-class-errors.txt b/utils/doclint/check_public_api/test/golden/01-class-errors.txt
diff --git a/utils/doclint/check_public_api/test/test.js b/utils/doclint/check_public_api/test/test.js
@@ -44,10 +44,6 @@ afterAll(SX(async function() {
   await browser.close();
 }));
 
-beforeEach(function() {
-  GoldenUtils.addMatchers(jasmine, GOLDEN_DIR, OUTPUT_DIR);
-});
-
 describe('checkPublicAPI', function() {
   it('01-class-errors', SX(test));
   it('02-method-errors', SX(test));
@@ -61,12 +57,13 @@ describe('checkPublicAPI', function() {
 
 async function test() {
   const dirPath = path.join(__dirname, specName);
+  GoldenUtils.addMatchers(jasmine, dirPath, dirPath);
   const factory = new SourceFactory();
   const mdSources = await factory.readdir(dirPath, '.md');
   const jsSources = await factory.readdir(dirPath, '.js');
   const messages = await checkPublicAPI(page, mdSources, jsSources);
   const errors = messages.map(message => message.text);
-  expect(errors.join('\n')).toBeGolden(specName + '.txt');
+  expect(errors.join('\n')).toBeGolden('result.txt');
 }
 
 // Since Jasmine doesn't like async functions, they should be wrapped