Merge pull request #18 from input-output-hk/piotr/acceptance-tests

Add acceptance scenarios

Author: piotr-iohk

README.md

@@ -6,6 +6,10 @@
   <img width="200" src=".github/images/cardano-logo.png"/>
 </p>
 
+<p align="center">
+  <a href="https://buildkite.com/input-output-hk/offchain-metadata-tools"><img src="https://badge.buildkite.com/7df25c563faffd8c7b09db8d802a73bd2ebc14ace98a432761.svg" alt="Build status"></a>
+</p>
+
 ## Overview
 
 In the Cardano multi-asset era, this project helps you create and

docs/index.org

@@ -1193,6 +1193,65 @@ libraries, but without Haskell packages, use =nix-shell default.nix -A
 cabal-shell=. You can then use cabal to build all Haskell package
 dependencies.
 
+*** Make a release
+
+  Follow this checklist when making a release.
+
+**** Preparing the release
+     :PROPERTIES:
+     :CUSTOM_ID: preparing-the-release
+     :END:
+
+  - [ ] Deploy offchain-metadata-tools to testnet such that
+    metadata-server is available at
+    https://metadata.cardano-testnet.iohkdev.io/ and new metadata can be
+    added in https://github.com/input-output-hk/metadata-registry-testnet
+
+**** Create the release notes
+     :PROPERTIES:
+     :CUSTOM_ID: create-the-release-notes
+     :END:
+
+  - [ ] Add a draft release to
+    https://github.com/input-output-hk/offchain-metadata-tools/releases,
+    so that the release notes can be reviewed.
+
+**** Acceptance tests
+     :PROPERTIES:
+     :CUSTOM_ID: acceptance-tests
+     :END:
+  /It is assumed that offchain-metadata-tools have been deployed to
+  testnet infrastructure prior to the release so e2e acceptance tests can
+  be executed./
+
+  - [ ] Verify the release notes point to relevant API documentation and
+    manual.
+
+  - [ ] Download release artifacts from the release page and make them
+    available on =$PATH=.
+
+  - [ ] Go over e2e acceptance tests ->
+    https://github.com/input-output-hk/offchain-metadata-tools/tree/master/test/Acceptance.md
+
+  - [ ] Run locally automated scenarios from
+    https://github.com/input-output-hk/offchain-metadata-tools/tree/master/token-metadata-creator/test
+
+  - [ ] Run pre-release load tests from
+    https://github.com/input-output-hk/offchain-metadata-tools/tree/master/test/load
+
+  #+begin_example
+    $ npm install
+    $ npm test
+  #+end_example
+
+**** Publication
+     :PROPERTIES:
+     :CUSTOM_ID: publication
+     :END:
+
+  - [ ] Once everyone has signed off (i.e. Tech lead, QA, Ops & Release
+    manager), publish the release.
+
 ** Reference
 *** Components of the offchain-metadata-tools project
 **** metadata-lib

test/Acceptance.md

@@ -0,0 +1,147 @@
+
+
+# Acceptance tests
+The document describes few high-level end-to-end scenarios that can be used as acceptance tests.
+
+## Scenarios
+1. Add new metadata
+2. Update metadata
+
+### Add new metadata
+
+0. Mint a new token on testnet, like https://github.com/input-output-hk/cardano-node/blob/master/scripts/byron-to-mary/mint.sh
+
+1. Add metadata entry to testnet metadata registry:
+
+```
+$ git clone https://github.com/input-output-hk/metadata-registry-testnet.git
+$ cd metadata-registry-testnet/registry
+```
+
+```
+$ token-metadata-creator entry --init bb59e0d0065c3368e0b7add747f
+795026a93489b550bf0ddfbd6dc636f6666636861696e546f6f6c7354657374696e67
+
+$ token-metadata-creator entry bb59e0d0065c3368e0b7add747f795026a93489b550bf0ddfbd6dc636f6666636861696e546f6f6c7354657374696e67 \
+  --name "OffchainToolsCoin" \
+  --description "Test OffchainTools" \
+  --policy /home/piotr/t/node/tokens/minter/offchain-tools-test/policy.script
+
+$ token-metadata-creator entry bb59e0d0065c3368e0b7add747f795026a93489b550bf0ddfbd6dc636f6666636861696e546f6f6c7354657374696e67 \
+  --ticker "OTC" \
+  --url "https://github.com/input-output-hk/offchain-metadata-tools/" \
+  --logo "/home/piotr/wb/offchain-metadata-tools/token-metadata-creator/test/testData/icon.png"
+
+$ token-metadata-creator entry bb59e0d0065c3368e0b7add747f795026a93489b550bf0ddfbd6dc636f6666636861696e546f6f6c7354657374696e67 -a /home/piotr/t/node/tokens/minter/offchain-tools-test/policy.skey
+
+$ token-metadata-creator entry bb59e0d0065c3368e0b7add747f795026a93489b550bf0ddfbd6dc636f6666636861696e546f6f6c7354657374696e67 --finalize
+
+$ token-metadata-creator validate bb59e0d0065c3368e0b7add747f795026a93489b550bf0ddfbd6dc636f6666636861696e546f6f6c7354657374696e67.json
+
+[Info]    [Main.log#281] Wallet metadata validation successful!
+```
+
+2. Commit file and create PR on https://github.com/input-output-hk/metadata-registry-testnet.git
+
+3. Validate PR.
+```
+$ metadata-validator-github --no-auth input-output-hk metadata-registry-testnet 94 --expect-branch master
+
+[Info]    [Cardano.Metadata.Validation.GitHub.gitHubValidationRules#146] Validating 1 files.
+[Info]    [Cardano.Metadata.Validation.GitHub.validatePRFile#198] Adding a record...
+
+```
+4. Merge PR.
+
+5. Check that metadata is displayed in cardano-wallet which holds tokens for which we defined metadata in metadata-registry:
+
+ - cardano-wallet must be started with `--token-metadata-server https://metadata.cardano-testnet.iohkdev.io/` parameter
+```
+cardano-wallet serve
+  --node-socket ../node/node.socket \
+  --testnet testnet-byron-genesis.json  \
+  --token-metadata-server https://metadata.cardano-testnet.iohkdev.io/ \
+  --database ./wallet-db
+```
+
+```
+curl -X GET http://localhost:8090/v2/wallets/1b0aa24994b4181e79116c131510f2abf6cdaa4f/assets | jq
+...
+  {
+    "asset_name": "6f6666636861696e546f6f6c7354657374696e67",
+    "fingerprint": "asset19ctrcwqhl2ttx97qr4n590v382k8l59getman3",
+    "policy_id": "bb59e0d0065c3368e0b7add747f795026a93489b550bf0ddfbd6dc63",
+    "metadata": {
+      "url": "https://github.com/input-output-hk/offchain-metadata-tools/",
+      "name": "OffchainToolsCoin",
+      "ticker": "OTC",
+      "logo": "...",
+      "description": "Test OffchainTools"
+    }
+  },
+```
+
+## Update metadata
+
+1. Update name in the already existing metadata:
+```
+$ token-metadata-creator entry bb59e0d0065c3368e0b7add747f795026a93489b550bf0ddfbd6dc636f6666636861696e546f6f6c7354657374696e67 \
+  --name "OffchainToolsCoin update"
+
+$ token-metadata-creator entry bb59e0d0065c3368e0b7add747f795026a93489b550bf0ddfbd6dc636f6666636861696e546f6f6c7354657374696e67 -a /home/piotr/t/node/tokens/minter/offchain-tools-test/policy.skey \
+ --attest-name
+
+$ token-metadata-creator entry bb59e0d0065c3368e0b7add747f795026a93489b550bf0ddfbd6dc636f6666636861696e546f6f6c7354657374696e67 --finalize
+```
+
+2. Verify that name `value` and `signature` are updated, also `sequenceNumber` is increased by one.
+
+```
+    "name": {
+        "sequenceNumber": 1,
+        "value": "OffchainToolsCoin update",
+        "signatures": [
+            {
+                "signature": "18967d36105d3cc749a831282e52456008483fe673c86f11e423c0e56e319c3649aae9eec0a3fac8dcdf99f1e3fbd126cb8d62db49ff9c4fb88eda9bb1c4f800",
+                "publicKey": "197b6c5c36b69919f3ac9952f9014de3fd096f6c7c0b34d55561942bd37d76a2"
+            }
+        ]
+    }
+```
+
+3. Validate the update:
+
+```
+$ token-metadata-creator validate bb59e0d0065c3368e0b7add747f795026a93489b550bf0ddfbd6dc636f6666636861696e546f6f6c7354657374696e67.json
+
+[Info]    [Main.log#281] Wallet metadata validation successful!
+```
+
+4. Commit file and create PR on https://github.com/input-output-hk/metadata-registry-testnet.git
+
+5. Validate PR.
+```
+$ metadata-validator-github --no-auth input-output-hk metadata-registry-testnet 95 --expect-branch master
+
+[Info]    [Cardano.Metadata.Validation.GitHub.gitHubValidationRules#146] Validating 1 files.
+[Info]    [Cardano.Metadata.Validation.GitHub.validatePRFile#197] Modifying a record...
+```
+6. Merge PR.
+7. Make sure that updated metadata is displayed in cardano-wallet which holds tokens for which we defined metadata in metadata-registry.
+```
+curl -X GET http://localhost:8090/v2/wallets/1b0aa24994b4181e79116c131510f2abf6cdaa4f/assets | jq
+...
+  {
+    "asset_name": "6f6666636861696e546f6f6c7354657374696e67",
+    "fingerprint": "asset19ctrcwqhl2ttx97qr4n590v382k8l59getman3",
+    "policy_id": "bb59e0d0065c3368e0b7add747f795026a93489b550bf0ddfbd6dc63",
+    "metadata": {
+      "url": "https://github.com/input-output-hk/offchain-metadata-tools/",
+      "name": "OffchainToolsCoin update",
+      "ticker": "OTC",
+      "logo": "...",
+      "description": "Test OffchainTools"
+    }
+  },
+
+```