From c1cb1dd692a597a1b503a58a23190326a3a0aaa0 Mon Sep 17 00:00:00 2001
From: Darren Kelly <darren.kelly@vechain.org>
Date: Mon, 25 Dec 2023 23:49:36 +0000
Subject: [PATCH] update readme and actions

---
 .github/workflows/integration-tests.yaml |   4 -
 .idea/workspace.xml                      |   4 +
 integration_tests/.gitignore             | 120 -----------------------
 integration_tests/README.md              |  17 ++--
 integration_tests/package.json           |   5 +-
 5 files changed, 16 insertions(+), 134 deletions(-)

diff --git a/.github/workflows/integration-tests.yaml b/.github/workflows/integration-tests.yaml
index 57f79c969..3b444e007 100644
--- a/.github/workflows/integration-tests.yaml
+++ b/.github/workflows/integration-tests.yaml
@@ -13,10 +13,6 @@ jobs:
       - name: Checkout code
         uses: actions/checkout@v3
 
-      - name: Run Compose
-        run: |
-          docker compose -f integration_tests/network/docker-compose.yaml up -d --wait 
-
       - name: Setup Node
         uses: actions/setup-node@v3
         with:
diff --git a/.idea/workspace.xml b/.idea/workspace.xml
index 26ff2675d..12d6d63b0 100644
--- a/.idea/workspace.xml
+++ b/.idea/workspace.xml
@@ -6,6 +6,10 @@
   <component name="ChangeListManager">
     <list default="true" id="fc9fa7d4-7002-40c6-9627-57bd3c454974" name="Changes" comment="">
       <change beforePath="$PROJECT_DIR$/.github/workflows/integration-tests.yaml" beforeDir="false" afterPath="$PROJECT_DIR$/.github/workflows/integration-tests.yaml" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/.idea/workspace.xml" beforeDir="false" afterPath="$PROJECT_DIR$/.idea/workspace.xml" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/integration_tests/.gitignore" beforeDir="false" afterPath="$PROJECT_DIR$/integration_tests/.gitignore" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/integration_tests/README.md" beforeDir="false" afterPath="$PROJECT_DIR$/integration_tests/README.md" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/integration_tests/package.json" beforeDir="false" afterPath="$PROJECT_DIR$/integration_tests/package.json" afterDir="false" />
     </list>
     <option name="SHOW_DIALOG" value="false" />
     <option name="HIGHLIGHT_CONFLICTS" value="true" />
diff --git a/integration_tests/.gitignore b/integration_tests/.gitignore
index 8af85eee7..9722dbfaf 100644
--- a/integration_tests/.gitignore
+++ b/integration_tests/.gitignore
@@ -12,123 +12,3 @@ node_modules
 # solidity-coverage files
 /coverage
 /coverage.json
-
-node_modules
-.env
-
-# Hardhat files
-/cache
-/artifacts
-
-# TypeChain files
-/typechain
-/typechain-types
-
-# solidity-coverage files
-/coverage
-/coverage.json
-
-node_modules
-.env
-
-# Hardhat files
-/cache
-/artifacts
-
-# TypeChain files
-/typechain
-/typechain-types
-
-# solidity-coverage files
-/coverage
-/coverage.json
-
-node_modules
-.env
-
-# Hardhat files
-/cache
-/artifacts
-
-# TypeChain files
-/typechain
-/typechain-types
-
-# solidity-coverage files
-/coverage
-/coverage.json
-
-node_modules
-.env
-
-# Hardhat files
-/cache
-/artifacts
-
-# TypeChain files
-/typechain
-/typechain-types
-
-# solidity-coverage files
-/coverage
-/coverage.json
-
-node_modules
-.env
-
-# Hardhat files
-/cache
-/artifacts
-
-# TypeChain files
-/typechain
-/typechain-types
-
-# solidity-coverage files
-/coverage
-/coverage.json
-
-node_modules
-.env
-
-# Hardhat files
-/cache
-/artifacts
-
-# TypeChain files
-/typechain
-/typechain-types
-
-# solidity-coverage files
-/coverage
-/coverage.json
-
-node_modules
-.env
-
-# Hardhat files
-/cache
-/artifacts
-
-# TypeChain files
-/typechain
-/typechain-types
-
-# solidity-coverage files
-/coverage
-/coverage.json
-
-node_modules
-.env
-
-# Hardhat files
-/cache
-/artifacts
-
-# TypeChain files
-/typechain
-/typechain-types
-
-# solidity-coverage files
-/coverage
-/coverage.json
diff --git a/integration_tests/README.md b/integration_tests/README.md
index 7be82e5d6..921430bf3 100644
--- a/integration_tests/README.md
+++ b/integration_tests/README.md
@@ -1,13 +1,12 @@
-# Sample Hardhat Project
+# VechainThor Integration Tests
 
-This project demonstrates a basic Hardhat use case. It comes with a sample contract, a test for that contract, and a script that deploys that contract.
-
-Try running some of the following tasks:
+## Prerequisites
+- [Docker](https://docs.docker.com/install/)
+- [Yarn](https://yarnpkg.com/en/docs/install)
+- [Node.js](https://nodejs.org/en/download/)
 
+## Runnig the tests
 ```shell
-npx hardhat help
-npx hardhat test
-REPORT_GAS=true npx hardhat test
-npx hardhat node
-npx hardhat run scripts/deploy.ts
+yarn install
+yarn test
 ```
diff --git a/integration_tests/package.json b/integration_tests/package.json
index 0ac5e3651..33298f069 100644
--- a/integration_tests/package.json
+++ b/integration_tests/package.json
@@ -8,7 +8,10 @@
   "private": false,
   "scripts": {
     "postinstall": "hardhat compile",
-    "test": "yarn mocha --exit",
+    "docker:up": "docker compose -f network/docker-compose.yaml up -d --wait",
+    "docker:down": "docker compose -f network/docker-compose.yaml down",
+    "docker:restart": "yarn docker:down && yarn docker:up",
+    "test": "yarn docker:restart && yarn mocha --exit; yarn docker:down",
     "generate:accounts": "ts-node scripts/generate-account.ts"
   },
   "devDependencies": {