Add code transformers (#51)

* Implement transformers

* Add transformer for Playground

* Create TestUtilities contract

* Add scripts and transactions for TestUtilities

* Add tests for TestUtilities

* Temporarily enable dev-tests

* Update path resolvers to use enable complex configs

* Add future code for removing hacky solution with import

* Update config for base path

* Drop type

* Update tests

* Uncomment line

* Update NOTICE

* Move testing utilities into FlowManager

* Remove TestUtilities

* Add interactions for block offset

* Remove dangerous rm -rf call

* Update package.lock

* Add utilities tests

* Add transformers for interactions

* Add transformers code

* Regenerate code

* Use AuthAccount

* Update utilities tests

* Update blockHeight related code and tests

* Brush up dev tests

* Refactor playground transformer

* Refactor emulator

* More tests around transformers

* Update year. Remove unused import

* Provide public method to resolve alias to address

* Regenerate code

* Update transformers and FlowManager to allow passing arguments instead of hardcoded values

* Refactor and clean the code

* Add new line at eof

* Remove dev tests

* Add new line at eof

* Fix package.json

* Update exports

* Remove unused import

* Fix test

* Regenerate code

* Export blockOffset related methods from generated code

* Update header with new year range

* Update tests to use generated method for controlling blockOffset

* Add documentation for blockOffset methods. Update executeScript and sendTransaction signatures. Add CadenceTransformer type

* Fix templates

* Bump flow-cadut version. Bump package version

* Update docs with new links. Update code examples in API section

* Create runnable code

* Add example runner

* Update  examples in API documentation

* Create runnable examples

* Update deploy code logic

* Prettify

* Update cadut package

* Update runner to include list of examples and allow to run by number

* Add more examples

* Update typo in documentation

* Get title from filename

* Update cadut package

* Refactor

* Update code for getBlockOffset and setBlockOffset methods

* Add more functionality to emulator

* Refactor block offset example

* Update emulator management example

* Add manager tests for block offset

* Fix exports for block offset methods

* Add test for emulator processing

* Refactor methods for data parsing

* Add array of dictionaries example

* Default logging to false

* Enable dev-test temporarly

* Add example to pass array of dictionaries

* Update cadut dependency

* Fix complex arg example

* Update example regexp

* Provide more examples

* Update example code in API reference

* Update flow-cadut package

* Prettify

* Use new version of flow-cadut

* Update array value

* Fix flow-cadut imports

Author: Maksim Daunarovich

NOTICE

@@ -1,4 +1,4 @@
 Flow
-Copyright 2019-2020 Dapper Labs, Inc.
+Copyright 2019-2021 Dapper Labs, Inc.
 
 This product includes software developed at Dapper Labs, Inc. (https://www.dapperlabs.com/). 

README.md

@@ -1,9 +1,8 @@
-<br />
-<p align="center">
+<div style="text-align: center; margin: 1em 0 2em">
   <a href="#">
     <img src="./js-testing-banner.svg" alt="Logo" width="680" height="auto">
   </a>
-
+  
   <p align="center">
     <i>Test your Flow applications written in Cadence with ease</i>
     <br />
@@ -14,11 +13,9 @@
     ·
     <a href="https://github.com/onflow/flow-js-testing/blob/master/CONTRIBUTING.md">Contribute</a>
     ·
-    <a href="/docs/installation.md">Installation</a>
+    <a href="/docs/install.md">Installation</a>
   </p>
-</p>
-<br />
-<br />
+</div>
 
 # JavaScript Testing Framework for Flow Network
 
@@ -41,11 +38,11 @@ If you have it already installed, run the `flow init` in your terminal to create
 Then start the emulator with `flow emulator -v`.
 
 ## Documentation
-- [Installation](/docs/installation.md)
+
+- [Installation](/docs/install.md)
 - [API](/docs/api.md)
-- Examples
-  - [Basic Usage](/docs/examples/basic.md)
-  - [Pass Metadata](/docs/examples/metadata.md)
+- Extra Examples
+  - [Metadata](/docs/examples/metadata.md)
 
 ## Playground Integration
 

cadence/contracts/FlowManager.cdc

@@ -1,5 +1,6 @@
 pub contract FlowManager {
 
+    /// Account Manager
     pub event AccountAdded(address: Address)
 
     pub struct Mapper {
@@ -19,15 +20,79 @@ pub contract FlowManager {
         }
     }
 
+    pub fun getAccountAddress(_ name: String): Address?{
+        let accountManager = self.account
+            .getCapability(self.accountManagerPath)
+            .borrow<&FlowManager.Mapper>()!
+
+        return accountManager.getAddress(name)
+    }
+
+    pub let defaultAccounts: {Address : String}
+
+    pub fun resolveDefaultAccounts(_ address: Address): Address{
+        let alias = self.defaultAccounts[address]!
+        return self.getAccountAddress(alias)!
+    }
+
     pub let accountManagerStorage: StoragePath
     pub let contractManagerStorage: StoragePath
     pub let accountManagerPath: PublicPath
     pub let contractManagerPath: PublicPath
 
+    /// Environment Manager
+    pub event BlockOffsetChanged(offset: UInt64)
+
+    pub struct MockBlock {
+        pub let id: [UInt8; 32]
+        pub let height: UInt64
+        pub let view: UInt64
+        pub let timestamp: UFix64
+
+        init(_ id: [UInt8; 32], _ height: UInt64, _ view: UInt64, _ timestamp: UFix64){
+            self.id = id
+            self.height = height
+            self.view = view
+            self.timestamp = timestamp
+        }
+    }
+
+    pub fun setBlockOffset(_ offset: UInt64){
+        self.blockOffset = offset
+        emit FlowManager.BlockOffsetChanged(offset: offset)
+    }
+
+    pub fun getBlockHeight(): UInt64 {
+        var block = getCurrentBlock()
+        return block.height + self.blockOffset
+    }
+
+    pub fun getBlock(): MockBlock {
+        var block =  getCurrentBlock()
+        let mockBlock = MockBlock(block.id, block.height, block.view, block.timestamp);
+        return mockBlock
+    }
+
+    pub var blockOffset: UInt64;
+
+
+    // Initialize contract
     init(){
+        // Environment defaults
+        self.blockOffset = 0;
+
+        // Account Manager initialization
         let accountManager = Mapper()
         let contractManager = Mapper()
 
+        self.defaultAccounts = {
+          0x01: "Alice",
+          0x02: "Bob",
+          0x03: "Charlie",
+          0x04: "Dave",
+          0x05: "Eve"
+        }
+
         self.accountManagerStorage = /storage/testSuitAccountManager
         self.contractManagerStorage = /storage/testSuitContractManager
 

cadence/scripts/get-block-offset.cdc

@@ -0,0 +1,5 @@
+import FlowManager from 0x01
+
+pub fun main():UInt64 {
+    return FlowManager.blockOffset
+}

cadence/transactions/create-account.cdc

@@ -15,4 +15,3 @@ transaction (_ name: String, pubKey: String, manager: Address) {
         accountManager.setAddress(name, address: address)
     }
 }
- 

cadence/transactions/deploy-contract.cdc

@@ -17,4 +17,4 @@ transaction(name:String, code: String, manager: Address ##ARGS-WITH-TYPES##) {
         let address = acct.address
         contractManager.setAddress(name, address: address)
     }
-}
+}

cadence/transactions/register-contract.cdc

@@ -8,4 +8,4 @@ transaction(name: String, address: Address) {
                                 .borrow<&FlowManager.Mapper>()!
         contractManager.setAddress(name, address: address)
     }
-}
+}

cadence/transactions/set-block-offset.cdc

@@ -0,0 +1,7 @@
+import FlowManager from 0x01
+
+transaction(offset: UInt64){
+    prepare(signer:AuthAccount){
+        FlowManager.setBlockOffset(offset)
+    }
+}

dev-test/cadence/scripts/read-mocked-offset.cdc

@@ -0,0 +1,10 @@
+import FlowManager from 0x01
+
+pub fun main(): UInt64 {
+    let mockedHeight = FlowManager.getBlockHeight();
+    let realHeight = getCurrentBlock().height;
+    log("Mocked Height: ".concat(mockedHeight.toString()))
+    log("Real Height: ".concat(realHeight.toString()))
+
+    return mockedHeight - realHeight;
+}

dev-test/imports.test.js

@@ -15,7 +15,7 @@ describe("import resolver", () => {
   beforeEach(async () => {
     const basePath = path.resolve(__dirname, "./cadence");
     const port = 8080;
-    await init(basePath, port);
+    await init(basePath, { port });
     return emulator.start(port, false);
   });
 

dev-test/metadata.test.js

@@ -1,6 +1,5 @@
 import path from "path";
 import { init, emulator, executeScript, shallResolve } from "../src";
-import { mapValuesToCode } from "flow-cadut";
 
 jest.setTimeout(10000);
 

dev-test/usage.test.js

@@ -22,8 +22,8 @@ describe("Basic Usage test", () => {
   beforeEach(async () => {
     const basePath = path.resolve(__dirname, "./cadence");
     const port = 8080;
-    await init(basePath, port);
-    return emulator.start(port, false);
+    await init(basePath, { port });
+    return emulator.start(port);
   });
 
   // Stop emulator, so it could be restarted