Get rid of .stepup/logs subdirectory

reproducible-reporting · Aug 24, 2024 · b6987dd · b6987dd
1 parent 110a2dc
commit b6987dd
Show file tree

Hide file tree

Showing 29 changed files with 37 additions and 39 deletions.
diff --git a/docs/advanced_topics/manual_cleaning.md b/docs/advanced_topics/manual_cleaning.md
@@ -41,9 +41,9 @@ If `cleanup` cannot connect to the StepUp director process, it will keep trying
 
 ```
 Trying to contact StepUp director process.
-File ./.stepup/logs/director not found.  Waiting 0.1 seconds.
-Socket /tmp/stepup-c9a12bau/director read from ./.stepup/logs/director does not exist. Stepup not running?  Waiting 0.2 seconds.
-Socket /tmp/stepup-c9a12bau/director read from ./.stepup/logs/director does not exist. Stepup not running?  Waiting 0.3 seconds.
+File ./.stepup/director.log not found.  Waiting 0.1 seconds.
+Socket /tmp/stepup-c9a12bau/director read from ./.stepup/director.log does not exist. Stepup not running?  Waiting 0.2 seconds.
+Socket /tmp/stepup-c9a12bau/director read from ./.stepup/director.log does not exist. Stepup not running?  Waiting 0.3 seconds.
 ...
 ```
 

diff --git a/stepup/core/director.py b/stepup/core/director.py
@@ -564,7 +564,7 @@ async def wait(self):
 def get_socket() -> str:
     """Block until the director socket is known and return it."""
     stepup_root = Path(os.getenv("STEPUP_ROOT", "./"))
-    path_director_log = stepup_root / ".stepup/logs/director"
+    path_director_log = stepup_root / ".stepup/director.log"
     secs = 0
     while True:
         time.sleep(secs)

diff --git a/stepup/core/pytest.py b/stepup/core/pytest.py
@@ -122,7 +122,7 @@ async def run_example(srcdir, tmpdir, overwrite_expected=False):
                     exp = fh.read().rstrip()
                 pairs.append((path_exp, cur, exp))
     finally:
-        for path_log in sorted(workdir.glob(".stepup/logs/*")):
+        for path_log in sorted(workdir.glob(".stepup/*.log")):
             print()
             print(f"########## {path_log} ##########")
             print()

diff --git a/stepup/core/tui.py b/stepup/core/tui.py
@@ -55,9 +55,9 @@ async def async_main():
 
     # Create dir
     dir_stepup = Path(".stepup")
-    dir_logs = dir_stepup / "logs"
-    dir_logs.rmtree_p()
-    dir_logs.makedirs_p()
+    dir_stepup.makedirs_p()
+    for path_log in dir_stepup.glob("*.log"):
+        path_log.remove_p()
 
     with tempfile.TemporaryDirectory(prefix="stepup-") as dir_sockets:
         dir_sockets = Path(dir_sockets)
@@ -92,7 +92,7 @@ async def async_main():
         if not args.interactive:
             argv.append("--non-interactive")
         try:
-            with open(".stepup/logs/director", "w") as log_file:
+            with open(".stepup/director.log", "w") as log_file:
                 process_director = await asyncio.create_subprocess_exec(
                     sys.executable,
                     *argv,

diff --git a/stepup/core/worker.py b/stepup/core/worker.py
@@ -560,7 +560,7 @@ def parse_args():
 async def async_main():
     args = parse_args()
     with contextlib.ExitStack() as stack:
-        ferr = stack.enter_context(open(f".stepup/logs/worker{args.worker_idx}", "w"))
+        ferr = stack.enter_context(open(f".stepup/worker{args.worker_idx}.log", "w"))
         stack.enter_context(contextlib.redirect_stderr(ferr))
         print(f"PID {os.getpid()}", file=sys.stderr)
         async with ReporterClient.socket(args.reporter_socket) as reporter:

diff --git a/tests/cases/amend/main.sh b/tests/cases/amend/main.sh
@@ -49,7 +49,7 @@ grep word2 out2.txt
 wait
 
 # Restart StepUp without changes
-rm -r .stepup/logs
+rm .stepup/*.log
 stepup -e -w 1 plan.py & # > current_stdout_02.txt &
 
 # Wait for the director and get its socket.
@@ -78,7 +78,7 @@ wait
 
 # Restart StepUp with changes
 echo "word2 and other" > inp2.txt
-rm -r .stepup/logs
+rm .stepup/*.log
 stepup -e -w 1 plan.py & # > current_stdout_03.txt &
 
 # Wait for the director and get its socket.

diff --git a/tests/cases/deferred_glob1/main.sh b/tests/cases/deferred_glob1/main.sh
@@ -32,7 +32,7 @@ wait
 
 # Restart the example with a different input
 export ENV_VAR_TEST_STEPUP_INP="static/sub/bar.txt"
-rm -r .stepup/logs
+rm .stepup/*.log
 stepup -w 1 plan.py & # > current_stdout_02.txt &
 
 # Wait for the director and get its socket.

diff --git a/tests/cases/env_vars/main.sh b/tests/cases/env_vars/main.sh
@@ -67,7 +67,7 @@ cp current_variables.txt current_variables_03.txt
 
 # Change a variable and restart
 export ENV_VAR_TEST_STEPUP_DFTHYH="CCCC"
-rm -r .stepup/logs
+rm .stepup/*.log
 stepup -e -w 1 plan.py & # > current_stdout_b.txt &
 
 # Wait for the director and get its socket.
@@ -94,7 +94,7 @@ cp current_variables.txt current_variables_04.txt
 
 # unset a variable and restart
 unset ENV_VAR_TEST_STEPUP_AWDFTD
-rm -r .stepup/logs
+rm .stepup/*.log
 stepup -e -w 1 plan.py & # > current_stdout_c.txt &
 
 # Wait for the director and get its socket.
@@ -121,7 +121,7 @@ wait
 
 # Set a variable again and restart
 export ENV_VAR_TEST_STEPUP_AWDFTD="DDDD"
-rm -r .stepup/logs
+rm .stepup/*.log
 stepup -e -w 1 plan.py & # > current_stdout_d.txt &
 
 # Wait for the director and get its socket.

diff --git a/tests/cases/env_vars_amend/main.sh b/tests/cases/env_vars_amend/main.sh
@@ -32,7 +32,7 @@ wait
 
 # Rerstart with changed variable
 export ENV_VAR_TEST_STEPUP_SDASFD="BBBB"
-rm -r .stepup/logs
+rm .stepup/*.log
 stepup -e -w 1 plan.py & # > current_stdout_02.txt &
 
 # Wait for the director and get its socket.

diff --git a/tests/cases/env_vars_path/main.sh b/tests/cases/env_vars_path/main.sh
@@ -31,7 +31,7 @@ wait
 
 # Restart the example with a different variable
 export ENV_VAR_TEST_STEPUP_PREFIX="FOO"
-rm -r .stepup/logs
+rm .stepup/*.log
 stepup -e -w 1 plan.py & # > current_stdout_02.txt &
 
 # Wait for the director and get its socket.

diff --git a/tests/cases/error_main_fails/main.sh b/tests/cases/error_main_fails/main.sh
@@ -30,7 +30,7 @@ wait
 
 # Run the example, version 2
 cp plan_02.py plan.py
-rm -r .stepup/logs
+rm .stepup/*.log
 stepup -e -w 1 plan.py & # > current_stdout_02.txt &
 
 # Wait for the director and get its socket.

diff --git a/tests/cases/no_data/main.sh b/tests/cases/no_data/main.sh
@@ -47,7 +47,7 @@ wait
 
 # Create file again and restart
 cp original.txt data.txt
-rm -r .stepup/logs
+rm .stepup/*.log
 stepup -e -w 1 plan.py & # > current_stdout_b.txt &
 
 # Wait for the director and get its socket.

diff --git a/tests/cases/no_static/main.sh b/tests/cases/no_static/main.sh
@@ -30,7 +30,7 @@ wait
 
 # Start stepup without checking expected output because watchdog file
 # order is not reproducible.
-rm -r .stepup/logs
+rm .stepup/*.log
 stepup -w 1 plan.py &
 
 # Wait for the director and get its socket.

diff --git a/tests/cases/optional_convert/main.sh b/tests/cases/optional_convert/main.sh
@@ -43,7 +43,7 @@ grep raw_03 used.txt
 
 # Restart with a different environment variables
 export ENV_VAR_TEST_STEPUP_IDX="1"
-rm -r .stepup/logs
+rm .stepup/*.log
 stepup -e -w 1 plan.py & # > current_stdout_b.txt &
 
 # Wait for the director and get its socket.

diff --git a/tests/cases/permissions_plan_restart/main.sh b/tests/cases/permissions_plan_restart/main.sh
@@ -32,7 +32,7 @@ wait
 
 # Restart the plan with executable step.py.
 chmod +x sub/plan.py
-rm -r .stepup/logs
+rm .stepup/*.log
 stepup -e -w 1 plan.py & # > current_stdout_02.txt &
 
 # Wait for the director and get its socket.

diff --git a/tests/cases/permissions_step_restart/main.sh b/tests/cases/permissions_step_restart/main.sh
@@ -31,7 +31,7 @@ wait
 
 # Restart the plan with executable step.py.
 chmod +x step.py
-rm -r .stepup/logs
+rm .stepup/*.log
 stepup -e -w 1 plan.py & # > current_stdout_02.txt &
 
 # Wait for the director and get its socket.

diff --git a/tests/cases/restart_blocked/main.sh b/tests/cases/restart_blocked/main.sh
@@ -31,7 +31,7 @@ wait
 
 # Modify a few things and restart
 cp plan_unblocked.py plan.py
-rm -r .stepup/logs
+rm .stepup/*.log
 stepup -w 1 plan.py & # > current_stdout_02.txt &
 
 # Wait for the director and get its socket.

diff --git a/tests/cases/restart_changes/main.sh b/tests/cases/restart_changes/main.sh
@@ -31,7 +31,7 @@ wait
 [[ -f source_01.txt ]] || exit 1
 
 # second with a different plan.
-rm -r .stepup/logs
+rm .stepup/*.log
 stepup -e -w 1 plan_02.py & # > current_stdout_02.txt &
 
 # Wait for the director and get its socket.

diff --git a/tests/cases/restart_deferred_glob/main.sh b/tests/cases/restart_deferred_glob/main.sh
@@ -33,7 +33,7 @@ grep first static/foo.txt
 grep first bar.txt
 
 # Run the plan again without any changes.
-rm -r .stepup/logs
+rm .stepup/*.log
 stepup -e -w 1 plan.py & # > current_stdout_02.txt &
 
 # Wait for the director and get its socket.
@@ -61,7 +61,7 @@ grep first bar.txt
 
 # Run the plan again with changes.
 echo second > static/foo.txt
-rm -r .stepup/logs
+rm .stepup/*.log
 stepup -e -w 1 plan.py & # > current_stdout_03.txt &
 
 # Wait for the director and get its socket.

diff --git a/tests/cases/restart_input/main.sh b/tests/cases/restart_input/main.sh
@@ -31,7 +31,7 @@ grep first output.txt
 
 # Run the plan with the second input.
 echo second > input.txt
-rm -r .stepup/logs
+rm .stepup/*.log
 stepup -w 1 plan.py & # > current_stdout_02.txt &
 
 # Wait for the director and get its socket.

diff --git a/tests/cases/restart_nochanges/main.sh b/tests/cases/restart_nochanges/main.sh
@@ -30,7 +30,7 @@ wait
 [[ -f quadruple.txt ]] || exit 1
 
 # Run the plan.
-rm -r .stepup/logs
+rm .stepup/*.log
 stepup -e -w 1 plan.py & # > current_stdout_02.txt &
 
 # Wait for the director and get its socket.

diff --git a/tests/cases/restart_orphan/main.sh b/tests/cases/restart_orphan/main.sh
@@ -29,7 +29,7 @@ wait
 [[ -f bar.txt ]] || exit 1
 
 # Run the plan.
-rm -r .stepup/logs
+rm .stepup/*.log
 stepup -e -w 1 plan.py & # > current_stdout_02.txt &
 
 # Wait for the director and get its socket.

diff --git a/tests/cases/restart_outdated_amend/main.sh b/tests/cases/restart_outdated_amend/main.sh
@@ -35,7 +35,7 @@ grep inp1 copy.txt
 rm inp1.txt
 echo inp2 > inp2.txt
 echo inp2.txt > subs.txt
-rm -r .stepup/logs
+rm .stepup/*.log
 stepup -e -w 1 plan.py & # > current_stdout_02.txt &
 
 # Wait for the director and get its socket.

diff --git a/tests/cases/restart_output/main.sh b/tests/cases/restart_output/main.sh
@@ -29,7 +29,7 @@ wait
 
 # Restart StepUp after removing the output.
 rm copy.txt
-rm -r .stepup/logs
+rm .stepup/*.log
 stepup -e -w 1 plan.py & # > current_stdout_02.txt &
 
 # Wait for the director and get its socket.

diff --git a/tests/cases/static_glob/main.sh b/tests/cases/static_glob/main.sh
@@ -58,7 +58,7 @@ wait
 # Modify nglob results and restart
 echo "Fourth input" > inp4.txt
 rm inp2.txt
-rm -r .stepup/logs
+rm .stepup/*.log
 stepup -e -w 1 plan.py & # > current_stdout_b.txt &
 
 # Wait for the director and get its socket.

diff --git a/tests/cases/static_nglob/main.sh b/tests/cases/static_nglob/main.sh
@@ -72,7 +72,7 @@ wait
 
 # Start stepup without checking expected output because watchdog file
 # order is not reproducible.
-rm -r .stepup/logs
+rm .stepup/*.log
 stepup -w 1 plan.py &
 
 # Wait for the director and get its socket.

diff --git a/tests/cases/static_nglob_partial/main.sh b/tests/cases/static_nglob_partial/main.sh
@@ -75,7 +75,7 @@ wait
 # Modify nglob results and restart
 echo "ty" > tail_y.txt
 echo "tz" > tail_z.txt
-rm -r .stepup/logs
+rm .stepup/*.log
 stepup -e -w 1 plan.py & # > current_stdout_b.txt &
 
 # Wait for the director and get its socket.

diff --git a/tests/cases/static_nglob_subdir/main.sh b/tests/cases/static_nglob_subdir/main.sh
@@ -35,7 +35,7 @@ wait
 
 # Restart with one more input
 echo three > sub/inp3.txt
-rm -r .stepup/logs
+rm .stepup/*.log
 stepup -e -w 1 plan.py & # > current_stdout_02.txt &
 
 # Wait for the director and get its socket.

diff --git a/tests/conftest.py b/tests/conftest.py
@@ -52,8 +52,6 @@ async def client(tmpdir) -> Iterator[AsyncRPCClient]:
         dir_stepup = Path(".stepup").absolute()
         dir_sockects = dir_stepup / "sockets"
         dir_sockects.makedirs_p()
-        dir_logs = dir_stepup / "logs"
-        dir_logs.makedirs_p()
         director_socket_path = dir_sockects / "director"
 
         with open("plan.py", "w") as fh: