Merge pull request #22 from nsec/full_test

Fully test the CLI, including `ctf init` in CI

Author: Res260

.github/workflows/tests.yml

@@ -108,19 +108,35 @@ jobs:
         run: |
           pip install -e .
 
+      - name: ctf init
+        run: |
+          ctf init test-ctf
+
+      - name: Copy CTF files
+        run: |
+            mkdir -p test-ctf/challenges
+            cp -r ./challenges test-ctf/
+            ls -al test-ctf/
+            ls -al test-ctf/challenges
+
       - name: Validate CTF structure
+        # Run this in the test-ctf directory
+        working-directory: test-ctf
         run: |
           ctf validate
 
       - name: Deployment check
+        working-directory: test-ctf
         run: |
           ctf check
 
       - name: File generation
+        working-directory: test-ctf
         run: |
           ctf generate
 
       - name: Test deployment looping through tracks
+        working-directory: test-ctf
         run: |
           IFS=" " read -r -a tracks <<< "$(python3 -c 'from ctf.utils import get_all_available_tracks,validate_track_can_be_deployed;print(str([t for t in get_all_available_tracks() if validate_track_can_be_deployed(t)]).strip("[]\x27").replace("\x27, \x27"," "))')"
 
@@ -135,12 +151,14 @@ jobs:
           ctf destroy --force
 
       - name: Test full deployment
+        working-directory: test-ctf
         run: |
           ctf deploy --production
           [ "$(incus list --all-projects -cn -fcsv | wc -l)" -eq 2 ] || exit 1
           ctf destroy --force
 
       - name: Test redeployment of Mock Track Apache PHP
+        working-directory: test-ctf
         run: |
           ctf deploy --production
           [ "$(incus list --all-projects -cn -fcsv | wc -l)" -eq 2 ] || exit 1
@@ -149,6 +167,7 @@ jobs:
           ctf destroy --force
 
       - name: Test deployment of a track not deployed without destroying the rest
+        working-directory: test-ctf
         run: |
           ctf deploy --production --tracks mock-track-apache-php
           [ "$(incus list --all-projects -cn -fcsv | wc -l)" -eq 1 ] || exit 1

ctf/__main__.py

@@ -93,40 +93,49 @@ def terraform_binary() -> str:
 
 
 def init(args: argparse.Namespace) -> None:
-    if (
-        os.path.isdir(os.path.join(args.path, "challenges"))
-        or os.path.isdir(os.path.join(args.path, ".deploy"))
-    ) and not args.force:
-        LOG.error(
-            f"Directory {args.path} is already initialized. Use --force to overwrite."
-        )
-        LOG.error(args.force)
-        exit(code=1)
+    created_directory = False
+    try:
+        if not os.path.isdir(args.path):
+            os.mkdir(args.path)
+            LOG.info(f'Creating directory "{args.path}"')
+            created_directory = True
+        elif (
+            os.path.isdir(os.path.join(args.path, "challenges"))
+            or os.path.isdir(os.path.join(args.path, ".deploy"))
+        ) and not args.force:
+            LOG.error(
+                f'Directory "{args.path}" is already initialized. Use --force to overwrite.'
+            )
+            LOG.error(args.force)
+            exit(code=1)
 
-    created_assets: list[str] = []
+        created_assets: list[str] = []
 
-    try:
         for asset in os.listdir(p := os.path.join(TEMPLATES_ROOT_DIRECTORY, "init")):
             dst_asset = os.path.join(args.path, asset)
             if os.path.isdir(src_asset := os.path.join(p, asset)):
                 shutil.copytree(src_asset, dst_asset, dirs_exist_ok=True)
-                LOG.info(f"Created {dst_asset} folder")
+                LOG.info(f'Created "{dst_asset}" folder')
             else:
                 shutil.copy(src_asset, dst_asset)
-                LOG.info(f"Created {dst_asset} file")
+                LOG.info(f'Created "{dst_asset}" file')
 
             created_assets.append(dst_asset)
 
     except Exception:
         import traceback
 
-        for asset in created_assets:
-            if os.path.isdir(asset):
-                shutil.rmtree(asset)
-                LOG.info(f"Removed created {asset} folder")
-            else:
-                os.unlink(asset)
-                LOG.info(f"Removed created {asset} file")
+        if created_directory:
+            shutil.rmtree(args.path)
+            LOG.info(f'Removed created "{args.path}" folder')
+        else:
+            for asset in created_assets:
+                if os.path.isdir(asset):
+                    shutil.rmtree(asset)
+                    LOG.info(f'Removed created "{asset}" folder')
+                else:
+                    os.unlink(asset)
+                    LOG.info(f'Removed created "{asset}" file')
 
         LOG.critical(traceback.format_exc())
 

pyproject.toml

@@ -18,7 +18,7 @@ dependencies = [
     "black",
     "tabulate==0.9.0",
 ]
-version = "1.2.0"
+version = "1.3.0"
 classifiers = [
     "Programming Language :: Python :: 3",
     "Operating System :: OS Independent",