290 Tests in docker #296

shramee · 2023-01-21T22:30:15Z

Usage related changes

Users are unaffected.

Development related changes

Executing tests in docker

You can use docker tester image. The image includes testing environment set up with everything required to run the tests. The spawned container has access to docker daemon so it can also run the tests that require spawning Devnet/Cairo CLI etc containers.

npm run docker-tester

This is take you in the container shell. Once in the container, you can use the test- scripts defined in package.json in an isolated environment.

Fixes #290

Checklist:

@FabijanC

@FabijanC To see if this looks good.

* Env defaults * Skip ppyenv install if already installed * `https` url for git

shramee · 2023-01-22T07:02:53Z

Sorry, this needs more testing.

getFixVolumeHostPathCallback() Uses environment variable STARKNET_HARDHAT_REPLACE_HOST_PATH

And STARKNET_HARDHAT_REPLACE_HOST_PATH env var to let JS know about the volume paths that need changing.

`STARKNET_HARDHAT_REPLACE_HOST_PATH` is now called `STARKNET_HARDHAT_DIND_HOST_PATH`

* Better names * Fewer logs

shramee · 2023-02-23T07:19:43Z

Add a ton of docs, let me know if it's a bit much and some of it is unnecessary...

Dockerized testing environment

We have added a Docker in Docker, called DinD, setup to run the tests that need to use Docker from within a Docker container.
This allows running tests easily without changing your development environment. Read about running tests in Executing tests in docker section. If you are not adding Docker container volumes you can skip this section.

Running tests inside DinD requires some additional setup/parsing when adding new Docker container volumes to map container paths.

Adding new docker container

If you are adding a new docker container with volumes please refer to the next section, Adding docker volumes, to properly parse host paths for Docker in Docker to work.

Adding docker volumes

For volume mounts, Use getVolumeHostPathFilter function from ./external-server/external-server to get the filter function to prepare paths for DinD if required.

Here's an example,

// import ...
import { getVolumeHostPathFilter } from "./external-server/external-server";

// A bunch of code...

const volumeHostPathFilter = getVolumeHostPathFilter();
// Docker volume mounting args
const volumes = [
    "-v",
    `${volumeHostPathFilter(pathInHost)}:${pathInContainer}`,
    "-v",
    `${volumeHostPathFilter(pathInHost2)}:${pathInContainer2}`
];

// Other bunch of code...

We get the filter function from getVolumeHostPathFilter(). Then host parts for every volume are passed filtered with volumeHostPathFilter function.

Testing

...

Executing tests in docker

You can use docker tester image. The image includes testing environment set up with everything required to run the tests. The spawned container has access to docker daemon so it can also run the tests that require spawning Devnet/Cairo CLI etc containers. Read more in Dockerized testing environment section.

npm run docker-tester

This is take you in the container shell. Once in the container, you can use the test- scripts defined in package.json in an isolated environment.

...

shramee · 2023-02-23T07:31:07Z

scripts/ensure-python.sh

@@ -7,6 +7,7 @@ set -eu
 PY_VERSION=3.8.9

 if [[ "$OSTYPE" == "linux-gnu"* ]]; then
-    which "/opt/circleci/.pyenv/versions/$PY_VERSION/bin/python" || pyenv install "$PY_VERSION"
+		# Install version PY_VERSION, but skip if already installed.
+    which "/opt/circleci/.pyenv/versions/$PY_VERSION/bin/python" || pyenv install "$PY_VERSION" -s


-s flag skips if pyenv version is already installed.
https://github.com/pyenv/pyenv/blob/master/COMMANDS.md#pyenv-install

-s/--skip-existing Skip the installation if the version appears to be installed already

shramee · 2023-02-23T07:32:42Z

scripts/install-devnet.sh

@@ -2,6 +2,9 @@

 set -eu

-pip3 install "starknet-devnet==$STARKNET_DEVNET"
+# Get default from config.json file
+STARKNET_DEVNET_DEFAULT=$(node -e "console.log(require('../config.json').STARKNET_DEVNET)")


Sets default for STARKNET_DEVNET env var from config.json

shramee · 2023-02-23T07:36:12Z

scripts/install-devnet.sh

+# Get default from config.json file
+STARKNET_DEVNET_DEFAULT=$(node -e "console.log(require('../config.json').STARKNET_DEVNET)")
+
+pip3 install "starknet-devnet==${STARKNET_DEVNET:=$STARKNET_DEVNET_DEFAULT}" | { grep --invert-match 'Requirement already satisfied:' || :; }


Uses STARKNET_DEVNET_DEFAULT fallback

grep removes Requirement already satisfied logs.

|| :; part, which is like or nothing;, prevents grep from exiting the process.

Instead of adding this comments to the PR, they would be more useful in the file itself (applicable for other such comments).

shramee · 2023-02-23T07:37:06Z

scripts/setup-venv.sh

@@ -13,7 +13,7 @@ echo "python version: $(python --version)"
 if [[ "$OSTYPE" == "darwin"* ]]; then
    export HOMEBREW_NO_INSTALL_CLEANUP=1
    brew ls --versions gmp || brew install gmp
-    CFLAGS=-I`brew --prefix gmp`/include LDFLAGS=-L`brew --prefix gmp`/lib pip3 install fastecdsa
+    CFLAGS=-I`brew --prefix gmp`/include LDFLAGS=-L`brew --prefix gmp`/lib pip3 install fastecdsa  | { grep --invert-match 'Requirement already satisfied:' || :; }


Same as https://github.com/Shard-Labs/starknet-hardhat-plugin/pull/296/files#r1115318562
Strips Requirement already satisfied logs and stops grep from exiting the process.

shramee · 2023-02-23T07:38:35Z

scripts/test.sh

@@ -10,12 +10,12 @@ CONFIG_FILE_NAME="hardhat.config.ts"
 # setup example repo
 rm -rf starknet-hardhat-example
 EXAMPLE_REPO_BRANCH="plugin"
-if [[ "$CIRCLE_BRANCH" == "master" ]] && [[ "$EXAMPLE_REPO_BRANCH" != "plugin" ]]; then
+if [[ "${CIRCLE_BRANCH:=}" == "master" ]] && [[ "$EXAMPLE_REPO_BRANCH" != "plugin" ]]; then


Empty default from CIRCLE_BRANCH

Devnet takes long to spawn sometimes, but does eventually. [skip ci]

[skip ci]

@FabijanC

@FabijanC Setting up for tests is now optional and can be skipped by setting environment variable `STARKNET_HARDHAT_TEST_SKIP_SETUP=1`. [skip ci]

For re-use [skip ci]

@FabijanC

[skip ci] @FabijanC This allows running one test case at a time.

And not individually for each test. [skip ci]

[skip ci]

* [skip ci]

FabijanC

Your PR seems to introduce changes that are already on master. Perhaps merging master into your branch would help (also there are conflicts with the target branch). It should be easier to review after that.

I haven't fully reviewed, but if I understand correctly, some parts of the coding (non-testing code) are now working differently just to enable testing with DinD?

FabijanC · 2023-03-03T08:57:38Z

scripts/install-devnet.sh

+# Get default from config.json file
+STARKNET_DEVNET_DEFAULT=$(node -e "console.log(require('../config.json').STARKNET_DEVNET)")
+
+pip3 install "starknet-devnet==${STARKNET_DEVNET:=$STARKNET_DEVNET_DEFAULT}" | { grep --invert-match 'Requirement already satisfied:' || :; }


Instead of adding this comments to the PR, they would be more useful in the file itself (applicable for other such comments).

shramee · 2023-03-06T11:24:22Z

Closed in favour of #331

shramee added 4 commits January 22, 2023 05:09

0xSpaceShard#290 Run tests in Docker

d2895c9

@FabijanC To see if this looks good.

0xSpaceShard#290 Tweaks for easier tests

acef7b8

* Env defaults * Skip ppyenv install if already installed * `https` url for git

Minor tweaks

b849ab6

0xSpaceShard#290 Docs

a1fefc9

shramee marked this pull request as draft January 22, 2023 07:03

shramee added 9 commits January 23, 2023 14:33

Image tags

c7309c8

Merge branch 'Shard-Labs:master' into 290-test

2d08767

[skip ci] Don't hardcode DEVNET

10a807d

[skip ci] Docker host path fix for DinD

c56e1fb

getFixVolumeHostPathCallback() Uses environment variable STARKNET_HARDHAT_REPLACE_HOST_PATH

[skip ci] Docker DinD config

42f4824

And STARKNET_HARDHAT_REPLACE_HOST_PATH env var to let JS know about the volume paths that need changing.

[skip ci] Env var add DIND

12e0db4

`STARKNET_HARDHAT_REPLACE_HOST_PATH` is now called `STARKNET_HARDHAT_DIND_HOST_PATH`

[skip ci] No requirement met logs pip

71d046e

[skip ci] Use deployed image

426e2cb

Merge branch 'Shard-Labs:master' into 290-test

3c11596

shramee marked this pull request as ready for review February 22, 2023 14:36

shramee added 4 commits February 23, 2023 11:35

[skip ci] Docker image tag

7f20ca5

[skip ci] Don't die if no grep

de085c1

[skip ci] Code improvements 😋

f3141b3

* Better names * Fewer logs

[skip ci] DinD dev.md docs

f5f9bc8

[skip ci] DinD dev.md updates

1ce3ba8

shramee commented Feb 23, 2023

View reviewed changes

shramee added 3 commits February 23, 2023 20:01

Minor tweaks

3c804e7

Devnet takes long to spawn sometimes, but does eventually. [skip ci]

Dind volume path filter in ./utils

870dd0b

[skip ci]

Optional test setup

2ac804d

@FabijanC Setting up for tests is now optional and can be skipped by setting environment variable `STARKNET_HARDHAT_TEST_SKIP_SETUP=1`. [skip ci]

shramee and others added 10 commits February 26, 2023 15:48

Move test to a function

b20fdcd

For re-use [skip ci]

Running individual tests

e958c7a

[skip ci] @FabijanC This allows running one test case at a time.

Run and stop devnet before all tests

763e37b

And not individually for each test. [skip ci]

Use host.docker.internal

1c665ab

[skip ci]

DinD docker devnet

d08de84

Allow axios timeout configuration via hardhat config (0xSpaceShard#322)

045ab04

* [skip ci]

Pass Declare Nonce to Starknet CLI (0xSpaceShard#324)

e7ff8d9

* [skip ci]

Provide nonce on deploy function (0xSpaceShard#323)

cad8570

* [skip ci]

Bump version to v0.7.3

ad50f14

Update to devnet v0.4.6 [skip testnet]

1808c77

FabijanC self-requested a review February 27, 2023 09:33

FabijanC requested changes Mar 3, 2023

View reviewed changes

Hardhat node port

679ac22

shramee closed this Mar 6, 2023

shramee mentioned this pull request Mar 6, 2023

290 tests v2 #331

Closed

11 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

290 Tests in docker #296

290 Tests in docker #296

shramee commented Jan 21, 2023 •

edited

Loading

shramee commented Jan 22, 2023

shramee commented Feb 23, 2023 •

edited

Loading

shramee Feb 23, 2023

shramee Feb 23, 2023

shramee Feb 23, 2023

FabijanC Mar 3, 2023

shramee Feb 23, 2023

shramee Feb 23, 2023

FabijanC left a comment •

edited

Loading

FabijanC Mar 3, 2023

shramee commented Mar 6, 2023

290 Tests in docker #296

290 Tests in docker #296

Conversation

shramee commented Jan 21, 2023 • edited Loading

Usage related changes

Development related changes

Executing tests in docker

Checklist:

shramee commented Jan 22, 2023

shramee commented Feb 23, 2023 • edited Loading

Dockerized testing environment

Adding new docker container

Adding docker volumes

Testing

...

Executing tests in docker

...

shramee Feb 23, 2023

Choose a reason for hiding this comment

shramee Feb 23, 2023

Choose a reason for hiding this comment

shramee Feb 23, 2023

Choose a reason for hiding this comment

FabijanC Mar 3, 2023

Choose a reason for hiding this comment

shramee Feb 23, 2023

Choose a reason for hiding this comment

shramee Feb 23, 2023

Choose a reason for hiding this comment

FabijanC left a comment • edited Loading

Choose a reason for hiding this comment

FabijanC Mar 3, 2023

Choose a reason for hiding this comment

shramee commented Mar 6, 2023

shramee commented Jan 21, 2023 •

edited

Loading

shramee commented Feb 23, 2023 •

edited

Loading

FabijanC left a comment •

edited

Loading