🪚 Normalize task names (#184)

DEVELOPMENT.md

@@ -153,7 +153,7 @@ pnpm hardhat lz:test:oapp:deploy
 And execute `hardhat` tasks as usual:
 
 ```bash
-pnpm hardhat lz:oapp:getDefaultConfig
+pnpm hardhat lz:oapp:config:get:default
 ```
 
 If you are developing tasks, it's useful to build the code when it changes. To do this, run the following from the project root:
@@ -211,3 +211,16 @@ If you encounter errors when running these tests, just set the environment varia
 ```bash
 CI=1 pnpm test
 ```
+
+#### Problems with snapshot updating
+
+If snapshots are used in a test that relies on filesystem paths, the situation becomes a bit complex. In long term, we should steer away from this approach as it makes updating snapshots a bit cumbersome.
+
+Should you need to update snapshots for this kind of tests, follow these steps:
+
+- Go to `docker-compose.yaml` and find the `volumes` section of the `tests` service
+- Uncomment the line that says `./tests:/app/tests` - this will link the contain & host directories where the snapshots are being written
+- Run the tests and pass a `-u` flag to `jest`
+  - `DOCKER_COMPOSE_RUN_TESTS_TURBO_ARGS="-- -u" pnpm test:ci` if you want to run all the tests
+  - `DOCKER_COMPOSE_RUN_TESTS_TURBO_ARGS="--filter=ua-devtools-evm-hardhat-test -- -u" pnpm test:ci` if you want to only run a specific test suite
+- Profit

docker-compose.yaml

@@ -56,6 +56,10 @@ services:
       - DOCKER_COMPOSE_RUN_TESTS_TURBO_ARGS=$DOCKER_COMPOSE_RUN_TESTS_TURBO_ARGS
     volumes:
       - ./node_modules/.cache/turbo:/app/node_modules/.cache/turbo
+      # Uncomment these lines if you run into issues with outdated snapshots
+      #
+      # See DEVELOPMENT.md for more details on this issue
+      # - ./tests:/app/tests
       # Hardhat has an issue with caching compilers inside a docker container,
       # failing with EACCES -13 error, pointing to a permissions issue with the cache folder.
       #

packages/ua-devtools-evm-hardhat/src/constants/tasks.ts

@@ -1,4 +1,4 @@
-export const TASK_LZ_WIRE_OAPP = 'lz:oapp:wire'
-export const TASK_LZ_GET_DEFAULT_CONFIG = 'lz:oapp:getDefaultConfig'
-export const TASK_LZ_GET_OAPP_CONFIG = 'lz:oapp:getOAppConfig'
-export const TASK_LZ_CHECK_WIRE_OAPP = 'lz:oapp:checkWire'
+export const TASK_LZ_OAPP_WIRE = 'lz:oapp:wire'
+export const TASK_LZ_OAPP_CONFIG_GET_DEFAULT = 'lz:oapp:config:get:default'
+export const TASK_LZ_OAPP_CONFIG_GET = 'lz:oapp:config:get'
+export const TASK_LZ_OAPP_CONFIG_CHECK = 'lz:oapp:config:check'

packages/ua-devtools-evm-hardhat/src/tasks/oapp/checkWire.ts → packages/ua-devtools-evm-hardhat/src/tasks/oapp/config.check.ts

@@ -2,7 +2,7 @@ import { ActionType } from 'hardhat/types'
 import { task, types } from 'hardhat/config'
 import { createLogger, setDefaultLogLevel } from '@layerzerolabs/io-devtools'
 import { printRecords } from '@layerzerolabs/io-devtools/swag'
-import { TASK_LZ_CHECK_WIRE_OAPP } from '@/constants/tasks'
+import { TASK_LZ_OAPP_CONFIG_CHECK } from '@/constants/tasks'
 import { printLogo } from '@layerzerolabs/io-devtools/swag'
 import { OAppOmniGraph } from '@layerzerolabs/ua-devtools'
 import { createConnectedContractFactory } from '@layerzerolabs/devtools-evm-hardhat'
@@ -50,7 +50,7 @@ export const checkWire: ActionType<TaskArgs> = async ({ oappConfig: oappConfigPa
 }
 
 task(
-    TASK_LZ_CHECK_WIRE_OAPP,
+    TASK_LZ_OAPP_CONFIG_CHECK,
     'outputs visual console table to show current state of oapp connections via configuration'
 )
     .addParam('oappConfig', 'Path to your LayerZero OApp config', './layerzero.config.js', types.string)

packages/ua-devtools-evm-hardhat/src/tasks/oapp/getDefaultConfig.ts → packages/ua-devtools-evm-hardhat/src/tasks/oapp/config.get.default.ts

@@ -2,7 +2,7 @@ import { ActionType } from 'hardhat/types'
 import { task } from 'hardhat/config'
 import { printRecord } from '@layerzerolabs/io-devtools'
 import { getReceiveConfig, getSendConfig } from '@/utils/taskHelpers'
-import { TASK_LZ_GET_DEFAULT_CONFIG } from '@/constants'
+import { TASK_LZ_OAPP_CONFIG_GET_DEFAULT } from '@/constants'
 
 interface TaskArgs {
     networks: string
@@ -47,7 +47,7 @@ export const getDefaultConfig: ActionType<TaskArgs> = async (taskArgs) => {
 }
 
 task(
-    TASK_LZ_GET_DEFAULT_CONFIG,
+    TASK_LZ_OAPP_CONFIG_GET_DEFAULT,
     'outputs the default Send and Receive Messaging Library versions and the default application config'
 )
     .addParam('networks', 'comma separated list of networks')

packages/ua-devtools-evm-hardhat/src/tasks/oapp/getOAppConfig.ts → packages/ua-devtools-evm-hardhat/src/tasks/oapp/config.get.ts

@@ -2,7 +2,7 @@ import { ActionType } from 'hardhat/types'
 import { task } from 'hardhat/config'
 import { printRecord } from '@layerzerolabs/io-devtools'
 import { getReceiveConfig, getSendConfig } from '@/utils/taskHelpers'
-import { TASK_LZ_GET_OAPP_CONFIG } from '@/constants/tasks'
+import { TASK_LZ_OAPP_CONFIG_GET } from '@/constants/tasks'
 import assert from 'assert'
 
 interface TaskArgs {
@@ -52,7 +52,7 @@ export const getOAppConfig: ActionType<TaskArgs> = async (taskArgs) => {
 }
 
 task(
-    TASK_LZ_GET_OAPP_CONFIG,
+    TASK_LZ_OAPP_CONFIG_GET,
     'outputs the default Send and Receive Messaging Library versions and the default application config'
 )
     .addParam('networks', 'comma separated list of networks')

packages/ua-devtools-evm-hardhat/src/tasks/oapp/index.ts

@@ -1,4 +1,4 @@
 import './wire'
-import './checkWire'
-import './getDefaultConfig'
-import './getOAppConfig'
+import './config.check'
+import './config.get.default'
+import './config.get'

packages/ua-devtools-evm-hardhat/src/tasks/oapp/wire.ts

@@ -1,6 +1,6 @@
 import { task, types } from 'hardhat/config'
 import type { ActionType } from 'hardhat/types'
-import { TASK_LZ_WIRE_OAPP } from '@/constants/tasks'
+import { TASK_LZ_OAPP_WIRE } from '@/constants/tasks'
 import {
     createLogger,
     setDefaultLogLevel,
@@ -194,7 +194,7 @@ const action: ActionType<TaskArgs> = async ({
 
     return [successfulTransactions, errors, transactionsToSign]
 }
-task(TASK_LZ_WIRE_OAPP, 'Wire LayerZero OApp')
+task(TASK_LZ_OAPP_WIRE, 'Wire LayerZero OApp')
     .addParam('oappConfig', 'Path to your LayerZero OApp config', './layerzero.config.js', types.string)
     .addParam('logLevel', 'Logging level. One of: error, warn, info, verbose, debug, silly', 'info', types.string)
     .addParam(

tests/ua-devtools-evm-hardhat-test/test/task/oapp/__snapshots__/wire.test.ts.snap

@@ -1,26 +1,26 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
-exports[`task/oapp/wire with invalid configs should fail if the config file does not exist 1`] = `[Error: Unable to read config file '/app/tests/ua-devtools-evm-hardhat-test/does-not-exist.js'. Check that the file exists and is readable to your terminal user]`;
+exports[`task lz:oapp:wire with invalid configs should fail if the config file does not exist 1`] = `[Error: Unable to read config file '/app/tests/ua-devtools-evm-hardhat-test/does-not-exist.js'. Check that the file exists and is readable to your terminal user]`;
 
-exports[`task/oapp/wire with invalid configs should fail if the config file is not a file 1`] = `[Error: Unable to read config file '/app/tests/ua-devtools-evm-hardhat-test/test/task/oapp'. Check that the file exists and is readable to your terminal user]`;
+exports[`task lz:oapp:wire with invalid configs should fail if the config file is not a file 1`] = `[Error: Unable to read config file '/app/tests/ua-devtools-evm-hardhat-test/test/task/oapp'. Check that the file exists and is readable to your terminal user]`;
 
-exports[`task/oapp/wire with invalid configs should fail if the config file is not a valid JSON or JS file 1`] = `[Error: Unable to read config file '/app/tests/ua-devtools-evm-hardhat-test/README.md': SyntaxError: Unexpected token '<']`;
+exports[`task lz:oapp:wire with invalid configs should fail if the config file is not a valid JSON or JS file 1`] = `[Error: Unable to read config file '/app/tests/ua-devtools-evm-hardhat-test/README.md': SyntaxError: Unexpected token '<']`;
 
-exports[`task/oapp/wire with invalid configs should fail with a malformed JS file (001) 1`] = `
+exports[`task lz:oapp:wire with invalid configs should fail with a malformed JS file (001) 1`] = `
 [Error: Config from file '/app/tests/ua-devtools-evm-hardhat-test/test/task/oapp/__data__/configs/invalid.config.001.js' is malformed. Please fix the following errors:
 
 Property 'contracts.0.contract': Invalid input
 Property 'contracts.1.contract': Invalid input
 Property 'connections': Required]
 `;
 
-exports[`task/oapp/wire with invalid configs should fail with a misconfigured file (001) 1`] = `[Error: Config from file '/app/tests/ua-devtools-evm-hardhat-test/test/task/oapp/__data__/configs/valid.config.misconfigured.001.js' is invalid: AssertionError [ERR_ASSERTION]: Could not find a deployment for contract 'NonExistent']`;
+exports[`task lz:oapp:wire with invalid configs should fail with a misconfigured file (001) 1`] = `[Error: Config from file '/app/tests/ua-devtools-evm-hardhat-test/test/task/oapp/__data__/configs/valid.config.misconfigured.001.js' is invalid: AssertionError [ERR_ASSERTION]: Could not find a deployment for contract 'NonExistent']`;
 
-exports[`task/oapp/wire with invalid configs should fail with an empty JS file 1`] = `
+exports[`task lz:oapp:wire with invalid configs should fail with an empty JS file 1`] = `
 [Error: Config from file '/app/tests/ua-devtools-evm-hardhat-test/test/task/oapp/__data__/configs/invalid.config.empty.js' is malformed. Please fix the following errors:
 
 Property 'contracts': Required
 Property 'connections': Required]
 `;
 
-exports[`task/oapp/wire with invalid configs should fail with an empty JSON file 1`] = `[Error: Unable to read config file '/app/tests/ua-devtools-evm-hardhat-test/test/task/oapp/__data__/configs/invalid.config.empty.json': SyntaxError: Unexpected end of JSON input]`;
+exports[`task lz:oapp:wire with invalid configs should fail with an empty JSON file 1`] = `[Error: Unable to read config file '/app/tests/ua-devtools-evm-hardhat-test/test/task/oapp/__data__/configs/invalid.config.empty.json': SyntaxError: Unexpected end of JSON input]`;

tests/ua-devtools-evm-hardhat-test/test/task/oapp/checkWire.test.ts → tests/ua-devtools-evm-hardhat-test/test/task/oapp/config.check.test.ts

@@ -2,9 +2,9 @@ import hre from 'hardhat'
 import { resolve } from 'path'
 import { isFile } from '@layerzerolabs/io-devtools'
 import { deployOAppFixture } from '../../__utils__/oapp'
-import { TASK_LZ_CHECK_WIRE_OAPP, TASK_LZ_WIRE_OAPP } from '@layerzerolabs/ua-devtools-evm-hardhat'
+import { TASK_LZ_OAPP_CONFIG_CHECK, TASK_LZ_OAPP_WIRE } from '@layerzerolabs/ua-devtools-evm-hardhat'
 
-describe('task: checkWire', () => {
+describe(`task ${TASK_LZ_OAPP_CONFIG_CHECK}`, () => {
     const CONFIGS_BASE_DIR = resolve(__dirname, '__data__', 'configs')
     const configPathFixture = (fileName: string): string => {
         const path = resolve(CONFIGS_BASE_DIR, fileName)
@@ -18,7 +18,7 @@ describe('task: checkWire', () => {
 
     it('should show no chains are connected', async () => {
         const oappConfig = configPathFixture('valid.config.connected.js')
-        const result = await hre.run(TASK_LZ_CHECK_WIRE_OAPP, { oappConfig })
+        const result = await hre.run(TASK_LZ_OAPP_CONFIG_CHECK, { oappConfig })
         const expectPoint = { eid: expect.any(Number), address: expect.any(String) }
         const expectVector = { from: expectPoint, to: expectPoint }
         expect(result).toEqual([
@@ -29,8 +29,8 @@ describe('task: checkWire', () => {
 
     it('should show both chains are connected after running wire', async () => {
         const oappConfig = configPathFixture('valid.config.connected.js')
-        await hre.run(TASK_LZ_WIRE_OAPP, { oappConfig, ci: true })
-        const result = await hre.run(TASK_LZ_CHECK_WIRE_OAPP, { oappConfig })
+        await hre.run(TASK_LZ_OAPP_WIRE, { oappConfig, ci: true })
+        const result = await hre.run(TASK_LZ_OAPP_CONFIG_CHECK, { oappConfig })
         const expectPoint = { eid: expect.any(Number), address: expect.any(String) }
         const expectVector = { from: expectPoint, to: expectPoint }
         expect(result).toEqual([

tests/ua-devtools-evm-hardhat-test/test/task/getDefaultConfig.test.ts → tests/ua-devtools-evm-hardhat-test/test/task/oapp/config.get.default.test.ts

@@ -3,21 +3,21 @@ import {
     getDefaultExecutorConfig,
     getDefaultUlnConfig,
     setupDefaultEndpoint,
-} from '../__utils__/endpoint'
+} from '../../__utils__/endpoint'
 import { createContractFactory, getEidForNetworkName } from '@layerzerolabs/devtools-evm-hardhat'
 import hre from 'hardhat'
-import { TASK_LZ_GET_DEFAULT_CONFIG } from '@layerzerolabs/ua-devtools-evm-hardhat'
+import { TASK_LZ_OAPP_CONFIG_GET_DEFAULT } from '@layerzerolabs/ua-devtools-evm-hardhat'
 import { omniContractToPoint } from '@layerzerolabs/devtools-evm'
 
-describe('task: getDefaultConfig', () => {
+describe(`task ${TASK_LZ_OAPP_CONFIG_GET_DEFAULT}`, () => {
     beforeEach(async () => {
         await deployEndpointFixture()
         await setupDefaultEndpoint()
     })
 
     it('should return default configurations', async () => {
         const networks = Object.keys(hre.userConfig.networks ?? {})
-        const getDefaultConfigTask = await hre.run(TASK_LZ_GET_DEFAULT_CONFIG, { networks: networks.toString() })
+        const getDefaultConfigTask = await hre.run(TASK_LZ_OAPP_CONFIG_GET_DEFAULT, { networks: networks.toString() })
         const contractFactory = createContractFactory()
         for (const localNetwork of networks) {
             const localEid = getEidForNetworkName(localNetwork)

tests/ua-devtools-evm-hardhat-test/test/task/getOAppConfig.test.ts → tests/ua-devtools-evm-hardhat-test/test/task/oapp/config.get.test.ts

@@ -3,14 +3,14 @@ import {
     getDefaultExecutorConfig,
     getDefaultUlnConfig,
     setupDefaultEndpoint,
-} from '../__utils__/endpoint'
+} from '../../__utils__/endpoint'
 import { createContractFactory, getEidForNetworkName } from '@layerzerolabs/devtools-evm-hardhat'
 import hre from 'hardhat'
 import { AddressZero } from '@ethersproject/constants'
-import { TASK_LZ_GET_OAPP_CONFIG } from '@layerzerolabs/ua-devtools-evm-hardhat'
+import { TASK_LZ_OAPP_CONFIG_GET } from '@layerzerolabs/ua-devtools-evm-hardhat'
 import { omniContractToPoint } from '@layerzerolabs/devtools-evm'
 
-describe('task: getOAppConfig', () => {
+describe(`task ${TASK_LZ_OAPP_CONFIG_GET}`, () => {
     beforeEach(async () => {
         await deployEndpointFixture()
         await setupDefaultEndpoint()
@@ -19,7 +19,7 @@ describe('task: getOAppConfig', () => {
     it('should return app default configurations when addresses are not oapps', async () => {
         const networks = Object.keys(hre.userConfig.networks ?? {})
         const addresses = new Array(networks.length).fill(AddressZero).toString()
-        const getDefaultConfigTask = await hre.run(TASK_LZ_GET_OAPP_CONFIG, {
+        const getDefaultConfigTask = await hre.run(TASK_LZ_OAPP_CONFIG_GET, {
             networks: networks.toString(),
             addresses: addresses.toString(),
         })