🪚 Enable user tests for create-lz-oapp (#314)

LayerZero-Labs · Jan 31, 2024 · 7aaf750 · 7aaf750
1 parent 68e5592
commit 7aaf750
Show file tree

Hide file tree

Showing 14 changed files with 74 additions and 34 deletions.
diff --git a/.changeset/fast-keys-joke.md b/.changeset/fast-keys-joke.md
@@ -0,0 +1,5 @@
+---
+"create-lz-oapp": patch
+---
+
+Update repository URL
diff --git a/.changeset/plenty-cars-jam.md b/.changeset/plenty-cars-jam.md
@@ -0,0 +1,6 @@
+---
+"@layerzerolabs/oapp-example": patch
+"@layerzerolabs/oft-example": patch
+---
+
+Fix compile & tests scripts for npm
diff --git a/docker-compose.registry.yaml b/docker-compose.registry.yaml
@@ -84,7 +84,7 @@ services:
     # If these are not provided, for example if running on a local machine,
     # we'll default them to our repository and and empty ref
     environment:
-      - LAYERZERO_EXAMPLES_REPOSITORY_URL=git@github.com:${GITHUB_REPOSITORY:-LayerZero-Labs/devtools}
+      - LAYERZERO_EXAMPLES_REPOSITORY_URL=https://github.com/${GITHUB_REPOSITORY:-LayerZero-Labs/devtools}.git
       - LAYERZERO_EXAMPLES_REPOSITORY_REF=${GITHUB_REF_NAME}
     working_dir: /app
     command:
@@ -93,6 +93,9 @@ services:
       - |
         pnpm config set registry http://npm-registry:4873/
 
+        echo "create-lz-oapp:repository   $LAYERZERO_EXAMPLES_REPOSITORY_URL"
+        echo "create-lz-oapp:ref          $LAYERZERO_EXAMPLES_REPOSITORY_REF"
+
         /app/tests-user/lib/bats-core/bin/bats --verbose-run --recursive ./tests-user/tests
     volumes:
       # If we want to clone from github.com, we'll need its public keys added to our SSH config

diff --git a/examples/oapp/.eslintignore b/examples/oapp/.eslintignore
@@ -2,4 +2,9 @@ artifacts
 cache
 dist
 node_modules
-out
+out
+*.log
+*.sol
+*.yaml
+*.lock
+package-lock.json
diff --git a/examples/oapp/.prettierignore b/examples/oapp/.prettierignore
@@ -2,4 +2,9 @@ artifacts/
 cache/
 dist/
 node_modules/
-out/
+out/
+*.log
+*ignore
+*.yaml
+*.lock
+package-lock.json
diff --git a/examples/oapp/README.md b/examples/oapp/README.md
@@ -44,10 +44,10 @@ pnpm compile:hardhat
 Or adjust the `package.json` to for example remove `forge` build:
 
 ```diff
-- "compile": "$npm_execpath compile:forge && $npm_execpath compile:hardhat",
+- "compile": "$npm_execpath run compile:forge && $npm_execpath run compile:hardhat",
 - "compile:forge": "forge build",
-- "compile:hardhat": "$npm_execpath hardhat compile",
-+ "compile": "$npm_execpath hardhat compile"
+- "compile:hardhat": "hardhat compile",
++ "compile": "hardhat compile"
 ```
 
 #### Running tests

diff --git a/examples/oapp/package.json b/examples/oapp/package.json
@@ -5,16 +5,16 @@
   "license": "MIT",
   "scripts": {
     "clean": "rm -rf artifacts cache out",
-    "compile": "$npm_execpath compile:forge && $npm_execpath compile:hardhat",
+    "compile": "$npm_execpath run compile:forge && $npm_execpath run compile:hardhat",
     "compile:forge": "forge build",
-    "compile:hardhat": "$npm_execpath hardhat compile",
-    "lint": "$npm_execpath lint:js && $npm_execpath lint:sol",
-    "lint:fix": "$npm_execpath prettier --write . && solhint 'contracts/**/*.sol' --fix --noPrompt",
-    "lint:js": "$npm_execpath eslint '**/*.js' && $npm_execpath prettier --check .",
+    "compile:hardhat": "hardhat compile",
+    "lint": "$npm_execpath run lint:js && $npm_execpath run lint:sol",
+    "lint:fix": "eslint --fix '**/*.js' && prettier --write . && solhint 'contracts/**/*.sol' --fix --noPrompt",
+    "lint:js": "eslint '**/*.js' && prettier --check .",
     "lint:sol": "solhint 'contracts/**/*.sol'",
-    "test": "$npm_execpath test:forge && $npm_execpath test:hardhat",
+    "test": "$npm_execpath run test:forge && $npm_execpath run test:hardhat",
     "test:forge": "forge test",
-    "test:hardhat": "$npm_execpath hardhat test"
+    "test:hardhat": "hardhat test"
   },
   "devDependencies": {
     "@babel/core": "^7.23.7",

diff --git a/examples/oft/.eslintignore b/examples/oft/.eslintignore
@@ -2,4 +2,9 @@ artifacts
 cache
 dist
 node_modules
-out
+out
+*.log
+*.sol
+*.yaml
+*.lock
+package-lock.json
diff --git a/examples/oft/.prettierignore b/examples/oft/.prettierignore
@@ -2,4 +2,9 @@ artifacts/
 cache/
 dist/
 node_modules/
-out/
+out/
+*.log
+*ignore
+*.yaml
+*.lock
+package-lock.json
diff --git a/examples/oft/README.md b/examples/oft/README.md
@@ -44,10 +44,10 @@ pnpm compile:hardhat
 Or adjust the `package.json` to for example remove `forge` build:
 
 ```diff
-- "compile": "$npm_execpath compile:forge && $npm_execpath compile:hardhat",
+- "compile": "$npm_execpath run compile:forge && $npm_execpath run compile:hardhat",
 - "compile:forge": "forge build",
-- "compile:hardhat": "$npm_execpath hardhat compile",
-+ "compile": "$npm_execpath hardhat compile"
+- "compile:hardhat": "hardhat compile",
++ "compile": "hardhat compile"
 ```
 
 #### Running tests

diff --git a/examples/oft/package.json b/examples/oft/package.json
@@ -4,16 +4,17 @@
   "private": true,
   "license": "MIT",
   "scripts": {
-    "compile": "$npm_execpath compile:forge && $npm_execpath compile:hardhat",
+    "clean": "rm -rf artifacts cache out",
+    "compile": "$npm_execpath run compile:forge && $npm_execpath run compile:hardhat",
     "compile:forge": "forge build",
-    "compile:hardhat": "$npm_execpath hardhat compile",
-    "lint": "$npm_execpath lint:js && $npm_execpath lint:sol",
-    "lint:fix": "$npm_execpath prettier --write . && solhint 'contracts/**/*.sol' --fix --noPrompt",
-    "lint:js": "$npm_execpath eslint '**/*.js' && $npm_execpath prettier --check .",
+    "compile:hardhat": "hardhat compile",
+    "lint": "$npm_execpath run lint:js && $npm_execpath run lint:sol",
+    "lint:fix": "eslint --fix '**/*.js' && prettier --write . && solhint 'contracts/**/*.sol' --fix --noPrompt",
+    "lint:js": "eslint '**/*.js' && prettier --check .",
     "lint:sol": "solhint 'contracts/**/*.sol'",
-    "test": "$npm_execpath test:forge && $npm_execpath test:hardhat",
+    "test": "$npm_execpath run test:forge && $npm_execpath run test:hardhat",
     "test:forge": "forge test",
-    "test:hardhat": "$npm_execpath hardhat test"
+    "test:hardhat": "hardhat test"
   },
   "devDependencies": {
     "@babel/core": "^7.23.7",

diff --git a/packages/create-lz-oapp/src/config.ts b/packages/create-lz-oapp/src/config.ts
@@ -5,7 +5,7 @@ import { isPackageManagerAvailable } from './utilities/installation'
  * To enable example development in a custom repository
  * we open the repository URL field to be taken from the environment
  */
-const repository = process.env['LAYERZERO_EXAMPLES_REPOSITORY_URL'] || 'git@github.com:LayerZero-Labs/devtools'
+const repository = process.env['LAYERZERO_EXAMPLES_REPOSITORY_URL'] || 'https://github.com/LayerZero-Labs/devtools.git'
 
 /**
  * To enable example development in a custom branch,

diff --git a/packages/create-lz-oapp/src/utilities/cloning.ts b/packages/create-lz-oapp/src/utilities/cloning.ts
@@ -64,7 +64,7 @@ export const cloneExample = async ({ example, destination }: Config) => {
             }
         }
 
-        throw new CloningError()
+        throw new CloningError(`Unknown error: ${error}`)
     }
 }
 

diff --git a/tests-user/tests/create-lz-oapp.bats b/tests-user/tests/create-lz-oapp.bats
@@ -83,62 +83,67 @@ teardown() {
 }
 
 @test "should work with pnpm & oapp example in CI mode" {
-    skip
     local DESTINATION="$PROJECTS_DIRECTORY/pnpm-oapp"
 
     npx --yes create-lz-oapp --ci --example oapp --destination $DESTINATION --package-manager pnpm
-    assert_success
     cd "$DESTINATION"
     pnpm compile
     pnpm test
+    pnpm lint
+    pnpm lint:fix
 }
 
 @test "should work with pnpm & oft example in CI mode" {
-    skip
     local DESTINATION="$PROJECTS_DIRECTORY/pnpm-oft"
 
     npx --yes create-lz-oapp --ci --example oft --destination $DESTINATION --package-manager pnpm
     cd "$DESTINATION"
     pnpm compile
     pnpm test
+    pnpm lint
+    pnpm lint:fix
 }
 
 @test "should work with yarn & oapp example in CI mode" {
-    skip
     local DESTINATION="$PROJECTS_DIRECTORY/yarn-oapp"
 
     npx --yes create-lz-oapp --ci --example oapp --destination $DESTINATION --package-manager yarn
     cd "$DESTINATION"
     yarn compile
     yarn test
+    yarn lint
+    yarn lint:fix
 }
 
 @test "should work with yarn & oft example in CI mode" {
-    skip
     local DESTINATION="$PROJECTS_DIRECTORY/yarn-oft"
 
     npx --yes create-lz-oapp --ci --example oft --destination $DESTINATION --package-manager yarn
     cd "$DESTINATION"
     yarn compile
     yarn test
+    yarn lint
+    yarn lint:fix
 }
 
 @test "should work with npm & oapp example in CI mode" {
-    skip
     local DESTINATION="$PROJECTS_DIRECTORY/npm-oapp"
 
     npx --yes create-lz-oapp --ci --example oapp --destination $DESTINATION --package-manager npm
     cd "$DESTINATION"
     npm run compile
     npm run test
+    npm run lint
+    npm run lint:fix
 }
 
 @test "should work with npm & oft example in CI mode" {
-    skip
     local DESTINATION="$PROJECTS_DIRECTORY/npm-oft"
 
     npx --yes create-lz-oapp --ci --example oft --destination $DESTINATION --package-manager npm
     cd "$DESTINATION"
     npm run compile
     npm run test
+    npm run lint
+    npm run lint:fix
 }
-Original file line number
+Diff line change
@@ Expand Up / @@ -2,4 +2,9 @@ artifacts @@
     cache
     dist
     node_modules
-    out
+    out
+    *.log
+    *.sol
+    *.yaml
+    *.lock
+    package-lock.json