chore: renaming sandbox log outputs to localnet (#330)

algorandfoundation · Oct 17, 2023 · d3b4554 · d3b4554 · github-actions · Oct 17, 2023
1 parent 0bc7c06
commit d3b4554
Show file tree

Hide file tree

Showing 19 changed files with 24 additions and 24 deletions.
diff --git a/src/algokit/cli/goal.py b/src/algokit/cli/goal.py
@@ -50,7 +50,7 @@ def goal_command(*, console: bool, goal_args: list[str]) -> None:
     sandbox = ComposeSandbox()
     compose_file_status = sandbox.compose_file_status()
     if compose_file_status is not ComposeFileStatus.UP_TO_DATE:
-        raise click.ClickException("Sandbox definition is out of date; please run `algokit localnet reset` first!")
+        raise click.ClickException("LocalNet definition is out of date; please run `algokit localnet reset` first!")
 
     if console:
         if goal_args:

diff --git a/src/algokit/cli/localnet.py b/src/algokit/cli/localnet.py
@@ -63,12 +63,12 @@ def start_localnet() -> None:
     sandbox.check_docker_compose_for_new_image_versions()
 
     if compose_file_status is ComposeFileStatus.MISSING:
-        logger.debug("Sandbox compose file does not exist yet; writing it out for the first time")
+        logger.debug("LocalNet compose file does not exist yet; writing it out for the first time")
         sandbox.write_compose_file()
     elif compose_file_status is ComposeFileStatus.UP_TO_DATE:
-        logger.debug("Sandbox compose file does not require updating")
+        logger.debug("LocalNet compose file does not require updating")
     else:
-        logger.warning("Sandbox definition is out of date; please run algokit localnet reset")
+        logger.warning("LocalNet definition is out of date; please run algokit localnet reset")
     sandbox.up()
 
 
@@ -78,7 +78,7 @@ def stop_localnet() -> None:
     compose_file_status = sandbox.compose_file_status()
     if compose_file_status is ComposeFileStatus.MISSING:
         logger.debug(
-            "Sandbox compose file does not exist yet; run `algokit localnet start` to start the AlgoKit LocalNet"
+            "LocalNet compose file does not exist yet; run `algokit localnet start` to start the AlgoKit LocalNet"
         )
     else:
         sandbox.stop()
@@ -99,7 +99,7 @@ def reset_localnet(*, update: bool) -> None:
     else:
         sandbox.down()
         if compose_file_status is not ComposeFileStatus.UP_TO_DATE:
-            logger.info("Sandbox definition is out of date; updating it to latest")
+            logger.info("LocalNet definition is out of date; updating it to latest")
             sandbox.write_compose_file()
         if update:
             sandbox.pull()

diff --git a/src/algokit/core/sandbox.py b/src/algokit/core/sandbox.py
@@ -86,14 +86,14 @@ def up(self) -> None:
     def stop(self) -> None:
         logger.info("Stopping AlgoKit LocalNet now...")
         self._run_compose_command("stop", bad_return_code_error_message="Failed to stop LocalNet")
-        logger.info("Sandbox Stopped; execute `algokit localnet start` to start it again.")
+        logger.info("LocalNet Stopped; execute `algokit localnet start` to start it again.")
 
     def down(self) -> None:
         logger.info("Deleting any existing LocalNet...")
         self._run_compose_command("down", stdout_log_level=logging.DEBUG)
 
     def pull(self) -> None:
-        logger.info("Looking for latest Sandbox images from DockerHub...")
+        logger.info("Fetching any container updates from DockerHub...")
         self._run_compose_command("pull --ignore-pull-failures --quiet")
 
     def logs(self, *, follow: bool = False, no_color: bool = False, tail: str | None = None) -> None:

diff --git a/tests/goal/test_goal.test_goal_compose_outdated.approved.txt b/tests/goal/test_goal.test_goal_compose_outdated.approved.txt
@@ -1,4 +1,4 @@
 DEBUG: Running 'docker version' in '{current_working_directory}'
 DEBUG: docker: STDOUT
 DEBUG: docker: STDERR
-Error: Sandbox definition is out of date; please run `algokit localnet reset` first!
+Error: LocalNet definition is out of date; please run `algokit localnet reset` first!
diff --git a/...lnet_reset.test_localnet_reset_with_existing_sandbox_with_out_of_date_config.approved.txt b/...lnet_reset.test_localnet_reset_with_existing_sandbox_with_out_of_date_config.approved.txt
@@ -7,7 +7,7 @@ Deleting any existing LocalNet...
 DEBUG: Running 'docker compose down' in '{app_config}/sandbox'
 DEBUG: docker: STDOUT
 DEBUG: docker: STDERR
-Sandbox definition is out of date; updating it to latest
+LocalNet definition is out of date; updating it to latest
 DEBUG: Running 'docker image inspect makerxau/algorand-indexer-dev:latest --format {{index (split (index .RepoDigests 0) "@") 1}}' in '{app_config}/sandbox'
 DEBUG: docker: sha256:bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb
 DEBUG: HTTP Request: GET https://registry.hub.docker.com/v2/repositories/makerxau/algorand-indexer-dev/tags/latest "HTTP/1.1 200 OK"

diff --git a/...t.test_localnet_reset_with_existing_sandbox_with_up_to_date_config_with_pull.approved.txt b/...t.test_localnet_reset_with_existing_sandbox_with_up_to_date_config_with_pull.approved.txt
@@ -7,7 +7,7 @@ Deleting any existing LocalNet...
 DEBUG: Running 'docker compose down' in '{app_config}/sandbox'
 DEBUG: docker: STDOUT
 DEBUG: docker: STDERR
-Looking for latest Sandbox images from DockerHub...
+Fetching any container updates from DockerHub...
 DEBUG: Running 'docker compose pull --ignore-pull-failures --quiet' in '{app_config}/sandbox'
 docker: STDOUT
 docker: STDERR

diff --git a/tests/localnet/test_localnet_start.test_localnet_img_check_cmd_error.approved.txt b/tests/localnet/test_localnet_start.test_localnet_img_check_cmd_error.approved.txt
@@ -10,7 +10,7 @@ Match all requests on http://localhost:4001/v2/status
 DEBUG: Running 'docker image inspect algorand/algod:latest --format {{index (split (index .RepoDigests 0) "@") 1}}' in '{app_config}/sandbox'
 DEBUG: Error checking indexer status: No response can be found for GET request on https://registry.hub.docker.com/v2/repositories/algorand/algod/tags/latest amongst:
 Match all requests on http://localhost:4001/v2/status
-DEBUG: Sandbox compose file does not exist yet; writing it out for the first time
+DEBUG: LocalNet compose file does not exist yet; writing it out for the first time
 Starting AlgoKit LocalNet now...
 DEBUG: Running 'docker compose up --detach --quiet-pull --wait' in '{app_config}/sandbox'
 docker: STDOUT

diff --git a/tests/localnet/test_localnet_start.test_localnet_start.approved.txt b/tests/localnet/test_localnet_start.test_localnet_start.approved.txt
@@ -10,7 +10,7 @@ DEBUG: HTTP Request: GET https://registry.hub.docker.com/v2/repositories/makerxa
 DEBUG: Running 'docker image inspect algorand/algod:latest --format {{index (split (index .RepoDigests 0) "@") 1}}' in '{app_config}/sandbox'
 DEBUG: docker: sha256:aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
 DEBUG: HTTP Request: GET https://registry.hub.docker.com/v2/repositories/algorand/algod/tags/latest "HTTP/1.1 200 OK"
-DEBUG: Sandbox compose file does not exist yet; writing it out for the first time
+DEBUG: LocalNet compose file does not exist yet; writing it out for the first time
 Starting AlgoKit LocalNet now...
 DEBUG: Running 'docker compose up --detach --quiet-pull --wait' in '{app_config}/sandbox'
 docker: STDOUT

diff --git a/tests/localnet/test_localnet_start.test_localnet_start_failure.approved.txt b/tests/localnet/test_localnet_start.test_localnet_start_failure.approved.txt
@@ -10,7 +10,7 @@ DEBUG: HTTP Request: GET https://registry.hub.docker.com/v2/repositories/makerxa
 DEBUG: Running 'docker image inspect algorand/algod:latest --format {{index (split (index .RepoDigests 0) "@") 1}}' in '{app_config}/sandbox'
 DEBUG: docker: sha256:aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
 DEBUG: HTTP Request: GET https://registry.hub.docker.com/v2/repositories/algorand/algod/tags/latest "HTTP/1.1 200 OK"
-DEBUG: Sandbox compose file does not exist yet; writing it out for the first time
+DEBUG: LocalNet compose file does not exist yet; writing it out for the first time
 Starting AlgoKit LocalNet now...
 DEBUG: Running 'docker compose up --detach --quiet-pull --wait' in '{app_config}/sandbox'
 docker: STDOUT

diff --git a/tests/localnet/test_localnet_start.test_localnet_start_health_bad_status.approved.txt b/tests/localnet/test_localnet_start.test_localnet_start_health_bad_status.approved.txt
@@ -10,7 +10,7 @@ DEBUG: HTTP Request: GET https://registry.hub.docker.com/v2/repositories/makerxa
 DEBUG: Running 'docker image inspect algorand/algod:latest --format {{index (split (index .RepoDigests 0) "@") 1}}' in '{app_config}/sandbox'
 DEBUG: docker: sha256:aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
 DEBUG: HTTP Request: GET https://registry.hub.docker.com/v2/repositories/algorand/algod/tags/latest "HTTP/1.1 200 OK"
-DEBUG: Sandbox compose file does not exist yet; writing it out for the first time
+DEBUG: LocalNet compose file does not exist yet; writing it out for the first time
 Starting AlgoKit LocalNet now...
 DEBUG: Running 'docker compose up --detach --quiet-pull --wait' in '{app_config}/sandbox'
 docker: STDOUT

diff --git a/tests/localnet/test_localnet_start.test_localnet_start_health_failure.approved.txt b/tests/localnet/test_localnet_start.test_localnet_start_health_failure.approved.txt
@@ -10,7 +10,7 @@ DEBUG: HTTP Request: GET https://registry.hub.docker.com/v2/repositories/makerxa
 DEBUG: Running 'docker image inspect algorand/algod:latest --format {{index (split (index .RepoDigests 0) "@") 1}}' in '{app_config}/sandbox'
 DEBUG: docker: sha256:aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
 DEBUG: HTTP Request: GET https://registry.hub.docker.com/v2/repositories/algorand/algod/tags/latest "HTTP/1.1 200 OK"
-DEBUG: Sandbox compose file does not exist yet; writing it out for the first time
+DEBUG: LocalNet compose file does not exist yet; writing it out for the first time
 Starting AlgoKit LocalNet now...
 DEBUG: Running 'docker compose up --detach --quiet-pull --wait' in '{app_config}/sandbox'
 docker: STDOUT

diff --git a/tests/localnet/test_localnet_start.test_localnet_start_out_date.approved.txt b/tests/localnet/test_localnet_start.test_localnet_start_out_date.approved.txt
@@ -12,7 +12,7 @@ DEBUG: Running 'docker image inspect algorand/algod:latest --format {{index (spl
 DEBUG: docker: sha256:bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb
 DEBUG: HTTP Request: GET https://registry.hub.docker.com/v2/repositories/algorand/algod/tags/latest "HTTP/1.1 200 OK"
 WARNING: algod has a new version available, run `algokit localnet reset --update` to get the latest version
-DEBUG: Sandbox compose file does not exist yet; writing it out for the first time
+DEBUG: LocalNet compose file does not exist yet; writing it out for the first time
 Starting AlgoKit LocalNet now...
 DEBUG: Running 'docker compose up --detach --quiet-pull --wait' in '{app_config}/sandbox'
 docker: STDOUT

diff --git a/tests/localnet/test_localnet_start.test_localnet_start_out_of_date_definition.approved.txt b/tests/localnet/test_localnet_start.test_localnet_start_out_of_date_definition.approved.txt
@@ -9,7 +9,7 @@ DEBUG: HTTP Request: GET https://registry.hub.docker.com/v2/repositories/makerxa
 DEBUG: Running 'docker image inspect algorand/algod:latest --format {{index (split (index .RepoDigests 0) "@") 1}}' in '{app_config}/sandbox'
 DEBUG: docker: sha256:aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
 DEBUG: HTTP Request: GET https://registry.hub.docker.com/v2/repositories/algorand/algod/tags/latest "HTTP/1.1 200 OK"
-WARNING: Sandbox definition is out of date; please run algokit localnet reset
+WARNING: LocalNet definition is out of date; please run algokit localnet reset
 Starting AlgoKit LocalNet now...
 DEBUG: Running 'docker compose up --detach --quiet-pull --wait' in '{app_config}/sandbox'
 docker: STDOUT

diff --git a/...localnet_start.test_localnet_start_out_of_date_definition_and_missing_config.approved.txt b/...localnet_start.test_localnet_start_out_of_date_definition_and_missing_config.approved.txt
@@ -9,7 +9,7 @@ DEBUG: HTTP Request: GET https://registry.hub.docker.com/v2/repositories/makerxa
 DEBUG: Running 'docker image inspect algorand/algod:latest --format {{index (split (index .RepoDigests 0) "@") 1}}' in '{app_config}/sandbox'
 DEBUG: docker: sha256:aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
 DEBUG: HTTP Request: GET https://registry.hub.docker.com/v2/repositories/algorand/algod/tags/latest "HTTP/1.1 200 OK"
-WARNING: Sandbox definition is out of date; please run algokit localnet reset
+WARNING: LocalNet definition is out of date; please run algokit localnet reset
 Starting AlgoKit LocalNet now...
 DEBUG: Running 'docker compose up --detach --quiet-pull --wait' in '{app_config}/sandbox'
 docker: STDOUT

diff --git a/tests/localnet/test_localnet_start.test_localnet_start_up_to_date_definition.approved.txt b/tests/localnet/test_localnet_start.test_localnet_start_up_to_date_definition.approved.txt
@@ -9,7 +9,7 @@ DEBUG: HTTP Request: GET https://registry.hub.docker.com/v2/repositories/makerxa
 DEBUG: Running 'docker image inspect algorand/algod:latest --format {{index (split (index .RepoDigests 0) "@") 1}}' in '{app_config}/sandbox'
 DEBUG: docker: sha256:aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
 DEBUG: HTTP Request: GET https://registry.hub.docker.com/v2/repositories/algorand/algod/tags/latest "HTTP/1.1 200 OK"
-DEBUG: Sandbox compose file does not require updating
+DEBUG: LocalNet compose file does not require updating
 Starting AlgoKit LocalNet now...
 DEBUG: Running 'docker compose up --detach --quiet-pull --wait' in '{app_config}/sandbox'
 docker: STDOUT

diff --git a/...t/test_localnet_start.test_localnet_start_with_gitpod_docker_compose_version.approved.txt b/...t/test_localnet_start.test_localnet_start_with_gitpod_docker_compose_version.approved.txt
@@ -10,7 +10,7 @@ DEBUG: HTTP Request: GET https://registry.hub.docker.com/v2/repositories/makerxa
 DEBUG: Running 'docker image inspect algorand/algod:latest --format {{index (split (index .RepoDigests 0) "@") 1}}' in '{app_config}/sandbox'
 DEBUG: docker: sha256:aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
 DEBUG: HTTP Request: GET https://registry.hub.docker.com/v2/repositories/algorand/algod/tags/latest "HTTP/1.1 200 OK"
-DEBUG: Sandbox compose file does not exist yet; writing it out for the first time
+DEBUG: LocalNet compose file does not exist yet; writing it out for the first time
 Starting AlgoKit LocalNet now...
 DEBUG: Running 'docker compose up --detach --quiet-pull --wait' in '{app_config}/sandbox'
 docker: STDOUT

diff --git a/...t_localnet_start.test_localnet_start_with_unparseable_docker_compose_version.approved.txt b/...t_localnet_start.test_localnet_start_with_unparseable_docker_compose_version.approved.txt
@@ -13,7 +13,7 @@ DEBUG: HTTP Request: GET https://registry.hub.docker.com/v2/repositories/makerxa
 DEBUG: Running 'docker image inspect algorand/algod:latest --format {{index (split (index .RepoDigests 0) "@") 1}}' in '{app_config}/sandbox'
 DEBUG: docker: sha256:aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
 DEBUG: HTTP Request: GET https://registry.hub.docker.com/v2/repositories/algorand/algod/tags/latest "HTTP/1.1 200 OK"
-DEBUG: Sandbox compose file does not exist yet; writing it out for the first time
+DEBUG: LocalNet compose file does not exist yet; writing it out for the first time
 Starting AlgoKit LocalNet now...
 DEBUG: Running 'docker compose up --detach --quiet-pull --wait' in '{app_config}/sandbox'
 docker: STDOUT

diff --git a/tests/localnet/test_localnet_stop.test_localnet_stop.approved.txt b/tests/localnet/test_localnet_stop.test_localnet_stop.approved.txt
@@ -7,4 +7,4 @@ Stopping AlgoKit LocalNet now...
 DEBUG: Running 'docker compose stop' in '{app_config}/sandbox'
 docker: STDOUT
 docker: STDERR
-Sandbox Stopped; execute `algokit localnet start` to start it again.
+LocalNet Stopped; execute `algokit localnet start` to start it again.
diff --git a/tests/localnet/test_localnet_stop.test_localnet_stop_no_existing_definition.approved.txt b/tests/localnet/test_localnet_stop.test_localnet_stop_no_existing_definition.approved.txt
@@ -4,4 +4,4 @@ DEBUG: Running 'docker version' in '{current_working_directory}'
 DEBUG: docker: STDOUT
 DEBUG: docker: STDERR
 DEBUG: Sandbox directory does not exist yet; creating it
-DEBUG: Sandbox compose file does not exist yet; run `algokit localnet start` to start the AlgoKit LocalNet
+DEBUG: LocalNet compose file does not exist yet; run `algokit localnet start` to start the AlgoKit LocalNet
File	Stmts	Miss	Cover	Missing
src/algokit
__init__.py	15	7	53%	6–13, 17–24, 32–34
__main__.py	2	2	0%	1–3
src/algokit/cli
completions.py	105	2	98%	80, 95
deploy.py	56	5	91%	34–36, 78, 96
dispenser.py	116	1	99%	74
doctor.py	48	3	94%	142–144
generate.py	57	1	98%	116
goal.py	39	1	97%	57
init.py	190	16	92%	272–273, 323, 326–328, 339, 383, 409, 449, 458–460, 463–468, 481
localnet.py	93	3	97%	162, 183–184
src/algokit/core
bootstrap.py	161	24	85%	103–104, 126, 149, 214, 217, 223–237, 246–251
conf.py	54	8	85%	10, 24, 28, 36, 38, 71–73
deploy.py	69	11	84%	61–64, 73–75, 79, 84, 91–93
dispenser.py	202	26	87%	88, 120–121, 138–146, 188–189, 195–197, 215–216, 256–257, 315, 329–331, 342–343, 353, 366, 381
doctor.py	65	7	89%	67–69, 92–94, 134
generate.py	41	2	95%	68, 86
goal.py	56	3	95%	27–28, 38
log_handlers.py	68	7	90%	50–51, 63, 112–116, 125
proc.py	45	1	98%	98
sandbox.py	181	15	92%	100–107, 118, 278, 294, 309–311, 327
typed_client_generation.py	80	5	94%	55–57, 70, 75
utils.py	18	2	89%	27–28
version_prompt.py	73	8	89%	27–28, 40, 59–62, 80, 109
TOTAL	1990	160	92%