Jest-did-matcher matcher message cleanup (#124)

* Jest-did-matcher matcher message cleanup

Also added a test case to DID URL matcher.

* Added how to read jest error messages in READMEs

Author: shigeya

README.md

@@ -42,6 +42,10 @@ npm i
 npm run generate-report
 ```
 
+## If tests are failing
+
+- Every time after updating any code, run `npm i`.
+- Please refer to [When you observe errors section in packages/did-core-test-server/README.md](packages/did-core-test-server/README.md#when-you-observe-errors)
 ## DID Working Group Repositories
 
 - [W3C Decentralized Identifier Specification v1.0](https://github.com/w3c/did-core)

packages/did-core-test-server/README.md

@@ -57,3 +57,33 @@ npm run docker:build
 npm run docker:publish
 npm run docker:run
 ```
+
+## When you observe errors
+
+- Run `npm i` at the top level of this repository. Running `npm i` guarantees every test code to build.
+- Run `npm test` in `packages/did-core-test-server` directory.
+  This way of test run will show detailed tests run. For example, the intentional change to 'did:' to 'did/' for example implementation cause this error:
+
+    ```
+  ● suites/did-identifier › IMPLEMENTATION ::DID Test Suite:: › 3.x Identifier - did:example - DID Test Suite - DID Working Group › 3.1 DID Syntax › did/example:123 › 3.1 DID Syntax - All DIDs MUST conform to the DID Syntax ABNF Rules.
+
+    expect(received).toBeValidDid()
+
+    Expected value to be of valid DID, but received:
+      "did/example:123"
+
+       7 |         it('3.1 DID Syntax - All DIDs MUST conform to the DID Syntax ' +
+       8 |           'ABNF Rules.', async () => {
+    >  9 |           expect(didExample).toBeValidDid();
+         |                              ^
+      10 |         });
+      11 |       });
+      12 |     });
+
+      at Object.<anonymous> (suites/did-identifier/did-syntax.js:9:30)
+    ```
+
+- The first line begins with `●` (shown in red, if you didn't change test framework(jest) configuration). This descriptive text includes the name of test suites, the name of the implementation (marked IMPLEMENTATION), and the DID or DID URL (begins with `did:`) for the test, and also the section number of the DID core specification relates to the test.
+- The second line shows how a test matcher (a test code idiom) applied.
+- The third line shows the reason for the error, the value in question (received value), and possibly an expected value.
+- If there are any errors in the test code itself, the second line may be a JavaScript error (E.g., `TypeError: Cannot read property '...' of undefined`). If this happens or found any anomalies, please open an issue at [ did-test-suite GitHub repository](https://github.com/w3c/did-test-suite/issues).

packages/jest-did-matcher/src/matchers/toBeAsciiString/index.js

@@ -10,9 +10,7 @@ const passMessage = received => () =>
 const failMessage = received => () => 
     matcherHint('.toBeAsciiString', 'received', '') +
     '\n\n' +
-    'Expected value to be of type INFRA string:\n' +
-    `  ${printExpected('type of INFRA string')}` +
-    'Received:\n' +
+    'Expected value to be of type INFRA string, but received:\n' +
     `  ${printReceived(received)}`;
 
 export default {

packages/jest-did-matcher/src/matchers/toBeBase58String/index.js

@@ -10,9 +10,7 @@ const passMessage = received => () =>
 const failMessage = received => () => 
     matcherHint('.toBeBase58String', 'received', '') +
     '\n\n' +
-    'Expected value to be of a Base58 string:\n' +
-    `  ${printExpected('a Base 58 string')}` +
-    'Received:\n' +
+    'Expected value to be of a Base58 string, but received:\n' +
     `  ${printReceived(received)}`;
 
 export default {

packages/jest-did-matcher/src/matchers/toBeDidCoreDatetime/index.js

@@ -10,9 +10,7 @@ const passMessage = received => () =>
 const failMessage = received => () => 
     matcherHint('.toBeDidCoreDatetime', 'received', '') +
     '\n\n' +
-    'Expected value to be of a valid DID Core Datetime:\n' +
-    `  ${printExpected('a valid DID Core Datetime')}\n` +
-    'Received:\n' +
+    'Expected value to be of a valid DID Core Datetime, but received:\n' +
     `  ${printReceived(received)}`;
 
 export default {

packages/jest-did-matcher/src/matchers/toBeDidDocumentPropertyValueType/index.js

@@ -10,9 +10,7 @@ const passMessage = received => () =>
 const failMessage = received => () =>
     matcherHint('.toBeDidDocumentPropertyValueType', 'received', '') +
     '\n\n' +
-    'Expected value to be of type allowed in DID Document:\n' +
-    `  ${printExpected('value type allowed in DID Document')}\n` +
-    'Received:\n' +
+    'Expected value to be of type allowed in DID Document, but received:\n' +
     `  ${printReceived(received)}`;
 
 export default {

packages/jest-did-matcher/src/matchers/toBeInfraMap/index.js

@@ -10,9 +10,7 @@ const passMessage = received => () =>
 const failMessage = received => () => 
     matcherHint('.toBeInfraMap', 'received', '') +
     '\n\n' +
-    'Expected value to be of type INFRA map:\n' +
-    `  ${printExpected('type of INFRA map')}` +
-    'Received:\n' +
+    'Expected value to be of type INFRA map, but received:\n' +
     `  ${printReceived(received)}`;
 
 export default {

packages/jest-did-matcher/src/matchers/toBeInfraString/index.js

@@ -10,9 +10,7 @@ const passMessage = received => () =>
 const failMessage = received => () => 
     matcherHint('.toBeInfraString', 'received', '') +
     '\n\n' +
-    'Expected value to be of type INFRA string:\n' +
-    `  ${printExpected('type of INFRA string')}` +
-    'Received:\n' +
+    'Expected value to be of type INFRA string, but received:\n' +
     `  ${printReceived(received)}`;
 
 export default {

packages/jest-did-matcher/src/matchers/toBeMediaType/index.js

@@ -10,9 +10,7 @@ const passMessage = received => () =>
 const failMessage = received => () => 
     matcherHint('.toBeMediaType', 'received', '') +
     '\n\n' +
-    'Expected value to be of a valid Media Type:\n' +
-    `  ${printExpected('a valid Media Type')}` +
-    'Received:\n' +
+    'Expected value to be of a valid Media Type, but received:\n' +
     `  ${printReceived(received)}`;
 
 export default {

packages/jest-did-matcher/src/matchers/toBeMultibaseString/index.js

@@ -10,9 +10,7 @@ const passMessage = received => () =>
 const failMessage = received => () =>
     matcherHint('.toBeMultibaseString', 'received', '') +
     '\n\n' +
-    'Expected value to be a Multibase string:\n' +
-    `  ${printExpected('a Multibase string')}` +
-    'Received:\n' +
+    'Expected value to be a Multibase string, but received:\n' +
     `  ${printReceived(received)}`;
 
 export default {

packages/jest-did-matcher/src/matchers/toBeValidDid/index.js

@@ -10,9 +10,7 @@ const passMessage = received => () =>
 const failMessage = received => () => 
     matcherHint('.toBeValidDid', 'received', '') +
     '\n\n' +
-    'Expected value to be of valid DID:\n' +
-    `  ${printExpected('DID')}` +
-    'Received:\n' +
+    'Expected value to be of valid DID, but received:\n' +
     `  ${printReceived(received)}`;
 
 export default {

packages/jest-did-matcher/src/matchers/toBeValidDidUrl/index.js

@@ -4,15 +4,13 @@ import predicate from './predicate';
 const passMessage = received => () =>
     matcherHint('.not.toBeValidDidUrl', 'received', '') +
     '\n\n' +
-    'Expected value to not be of valid DID URL received:\n' +
+    'Expected value not to be a valid DID URL received:\n' +
     `  ${printReceived(received)}`;
 
 const failMessage = received => () => 
     matcherHint('.toBeValidDidUrl', 'received', '') +
     '\n\n' +
-    'Expected value to be of valid DID URL:\n' +
-    `  ${printExpected('DID URL')}` +
-    'Received:\n' +
+    'Expected value to be a valid DID URL, but received:\n' +
     `  ${printReceived(received)}`;
 
 export default {

packages/jest-did-matcher/src/matchers/toBeValidDidUrl/index.test.js

@@ -15,6 +15,7 @@ describe('.toBeValidDidUrl', () => {
     ["did:example:123456/path%20with%20space"],
     ["did:example:123456?versionId=1"],
     ["did:example:123#public-key-0"],
+    ["did:example:123#sig_064bebcc"],
     ["did:example:123?service=agent&relativeRef=/credentials#degree"]
   ]).test('passes when the item is a valid DID: %s', given => {
     expect(given).toBeValidDidUrl();

packages/jest-did-matcher/src/matchers/toBeValidUri/index.js

@@ -10,9 +10,7 @@ const passMessage = received => () =>
 const failMessage = received => () => 
     matcherHint('.toBeValidUri', 'received', '') +
     '\n\n' +
-    'Expected value to be of a valid URI:\n' +
-    `  ${printExpected('a valid Uri')}` +
-    'Received:\n' +
+    'Expected value to be of a valid URI, but received:\n' +
     `  ${printReceived(received)}`;
 
 export default {

packages/jest-did-matcher/src/matchers/toBeValidUrl/index.js

@@ -10,9 +10,7 @@ const passMessage = received => () =>
 const failMessage = received => () => 
     matcherHint('.toBeValidUrl', 'received', '') +
     '\n\n' +
-    'Expected value to be of a valid URL:\n' +
-    `  ${printExpected('a valid URL')}` +
-    'Received:\n' +
+    'Expected value to be of a valid URL, but received:\n' +
     `  ${printReceived(received)}`;
 
 export default {