cocalc-api: fix tests, creating accounts started many project servers – which is actually something a mere API call via the org management should not do

Author: haraldschilly

src/packages/server/accounts/account-creation-actions.ts

@@ -16,12 +16,15 @@ export default async function accountCreationActions({
   account_id,
   tags,
   noFirstProject,
+  dontStartProject,
 }: {
   email_address?: string;
   account_id: string;
   tags?: string[];
   // if set, don't do any initial project actions (i.e., creating or starting projects)
   noFirstProject?: boolean;
+  // if set, create the first project but do not start it. Only applies if noFirstProject is false.
+  dontStartProject?: boolean;
 }): Promise<void> {
   log.debug({ account_id, email_address, tags });
 
@@ -56,7 +59,7 @@ export default async function accountCreationActions({
           const projects = await getProjects({ account_id, limit: 1 });
           if (projects.length == 0) {
             // you really have no projects at all.
-            await firstProject({ account_id, tags });
+            await firstProject({ account_id, tags, dontStartProject });
           }
         } catch (err) {
           // non-fatal; they can make their own project
@@ -65,19 +68,22 @@ export default async function accountCreationActions({
       })();
     } else if (numProjects > 0) {
       // Make sure project is running so they have a good first experience.
-      (async () => {
-        try {
-          const { project_id } = await getOneProject(account_id);
-          const project = getProject(project_id);
-          await project.start();
-        } catch (err) {
-          log.error(
-            "failed to start newest project invited to",
-            err,
-            account_id,
-          );
-        }
-      })();
+      // Only start if dontStartProject is not set
+      if (!dontStartProject) {
+        (async () => {
+          try {
+            const { project_id } = await getOneProject(account_id);
+            const project = getProject(project_id);
+            await project.start();
+          } catch (err) {
+            log.error(
+              "failed to start newest project invited to",
+              err,
+              account_id,
+            );
+          }
+        })();
+      }
     }
   }
 }

src/packages/server/accounts/create-account.ts

@@ -27,6 +27,8 @@ interface Params {
   // I added this to avoid leaks with unit testing, but it may be useful in other contexts, e.g.,
   // avoiding confusion with self-hosted installs.
   noFirstProject?: boolean;
+  // if set, create the first project but do not start it. Only applies if noFirstProject is false.
+  dontStartProject?: boolean;
 }
 
 export default async function createAccount({
@@ -39,6 +41,7 @@ export default async function createAccount({
   signupReason,
   owner_id,
   noFirstProject,
+  dontStartProject,
 }: Params): Promise<void> {
   try {
     log.debug(
@@ -78,11 +81,11 @@ export default async function createAccount({
       account_id,
       tags,
       noFirstProject,
+      dontStartProject,
     });
     await creationActionsDone(account_id);
   } catch (error) {
     log.error("Error creating account", error);
     throw error; // re-throw to bubble up to higher layers if needed
   }
 }
-

src/packages/server/accounts/first-project.ts

@@ -22,9 +22,11 @@ const log = getLogger("server:accounts:first-project");
 export default async function firstProject({
   account_id,
   tags,
+  dontStartProject,
 }: {
   account_id: string;
   tags?: string[];
+  dontStartProject?: boolean;
 }): Promise<string> {
   log.debug(account_id, tags);
   if (!isValidUUID(account_id)) {
@@ -35,8 +37,10 @@ export default async function firstProject({
     title: "My First Project",
   });
   log.debug("created new project", project_id);
-  const project = getProject(project_id);
-  await project.start();
+  if (!dontStartProject) {
+    const project = getProject(project_id);
+    await project.start();
+  }
   if (!WELCOME_FILES || tags == null || tags.length == 0) {
     return project_id;
   }
@@ -57,7 +61,7 @@ export default async function firstProject({
             account_id,
             project_id,
             language,
-            welcome + jupyterExtra
+            welcome + jupyterExtra,
           );
         }
       }
@@ -78,7 +82,7 @@ async function createJupyterNotebookIfAvailable(
   account_id: string,
   project_id: string,
   language: string,
-  welcome: string
+  welcome: string,
 ): Promise<string> {
   // find the highest priority kernel with the given language
   let kernelspec: any = null;
@@ -129,7 +133,7 @@ async function createWelcome(
   account_id: string,
   project_id: string,
   ext: string,
-  welcome: string
+  welcome: string,
 ): Promise<string> {
   const path = `welcome/welcome.${ext}`;
   const { torun } = TAGS_MAP[ext] ?? {};

src/packages/server/conat/api/org.ts

@@ -285,6 +285,7 @@ export async function createUser({
     account_id: new_account_id,
     owner_id: account_id,
     password,
+    dontStartProject: true, // Don't auto-start projects for API-created users. A "first project" will be created, though.
   });
   // add account to org
   const pool = getPool();

src/python/cocalc-api/tests/conftest.py

@@ -2,6 +2,7 @@
 Pytest configuration and fixtures for cocalc-api tests.
 """
 import os
+import time
 import uuid
 import pytest
 
@@ -25,6 +26,25 @@ def assert_valid_uuid(value, description="value"):
         pytest.fail(f"{description} should be a valid UUID, got: {value}")
 
 
+def cleanup_project(hub, project_id):
+    """
+    Clean up a test project by stopping it and deleting it.
+
+    Args:
+        hub: Hub client instance
+        project_id: Project ID to cleanup
+    """
+    try:
+        hub.projects.stop(project_id)
+    except Exception as e:
+        print(f"Warning: Failed to stop project {project_id}: {e}")
+
+    try:
+        hub.projects.delete(project_id)
+    except Exception as e:
+        print(f"Warning: Failed to delete project {project_id}: {e}")
+
+
 @pytest.fixture(scope="session")
 def api_key():
     """Get API key from environment variable."""
@@ -59,18 +79,11 @@ def temporary_project(hub, request):
     title = f"CoCalc API Test {timestamp}"
     description = "Temporary project created by cocalc-api tests"
 
-    print("\n" + "="*70)
-    print("=== Creating temporary project for entire test session ===")
-    print("=== THIS SHOULD ONLY PRINT ONCE ===")
-    print("="*70)
     project_id = hub.projects.create_project(title=title, description=description)
-    print(f"Created project {project_id}")
-    print("="*70)
 
     # Start the project so it can respond to API calls
     try:
         hub.projects.start(project_id)
-        print(f"Starting project {project_id}, waiting for it to become ready...")
 
         # Wait for project to be ready (can take 10-15 seconds)
         from cocalc_api import Project
@@ -81,39 +94,19 @@ def temporary_project(hub, request):
                 # Try to ping the project to see if it's ready
                 test_project = Project(project_id=project_id, api_key=hub.api_key, host=hub.host)
                 test_project.system.ping()  # If this succeeds, project is ready
-                print(f"✓ Project {project_id} is ready after {(attempt + 1) * 5} seconds")
                 break
             except Exception:
                 if attempt == 9:  # Last attempt
-                    print(f"⚠ Warning: Project {project_id} did not become ready within 50 seconds")
+                    print(f"Warning: Project {project_id} did not become ready within 50 seconds")
 
     except Exception as e:
-        print(f"⚠ Warning: Failed to start project {project_id}: {e}")
+        print(f"Warning: Failed to start project {project_id}: {e}")
 
     project_info = {'project_id': project_id, 'title': title, 'description': description}
 
-    # Register cleanup using finalizer (more reliable than yield teardown)
+    # Register cleanup using finalizer
     def cleanup():
-        print(f"\n=== Cleaning up test project '{title}' (ID: {project_id}) ===")
-
-        try:
-            # Stop the project first
-            print(f"Stopping project {project_id}...")
-            hub.projects.stop(project_id)
-            print("✓ Project stop command sent")
-            # Wait for the project process to actually terminate
-            time.sleep(3)
-            print(f"✓ Waited for project {project_id} to stop")
-        except Exception as e:
-            print(f"⚠ Failed to stop project {project_id}: {e}")
-
-        try:
-            # Delete the project
-            print(f"Deleting project {project_id}...")
-            hub.projects.delete(project_id)
-            print(f"✓ Project {project_id} deleted")
-        except Exception as e:
-            print(f"⚠ Failed to delete project {project_id}: {e}")
+        cleanup_project(hub, project_id)
 
     request.addfinalizer(cleanup)
 

src/python/cocalc-api/tests/test_hub.py

@@ -5,7 +5,7 @@
 import pytest
 
 from cocalc_api import Hub, Project
-from .conftest import assert_valid_uuid
+from .conftest import assert_valid_uuid, cleanup_project
 
 
 class TestHubSystem:
@@ -69,19 +69,9 @@ def test_create_project(self, hub):
         try:
             assert project_id is not None
             assert_valid_uuid(project_id, "Project ID")
-            print(f"✓ Created project: {project_id}")
         finally:
             # Cleanup: stop then delete the project
-            try:
-                print(f"Cleaning up test project {project_id}...")
-                hub.projects.stop(project_id)
-                print("✓ Project stop command sent")
-                time.sleep(3)  # Wait for process to terminate
-                print(f"✓ Waited for project {project_id} to stop")
-                hub.projects.delete(project_id)
-                print(f"✓ Project {project_id} deleted")
-            except Exception as e:
-                print(f"⚠ Failed to cleanup project {project_id}: {e}")
+            cleanup_project(hub, project_id)
 
     def test_list_projects(self, hub):
         """Test listing projects."""
@@ -162,15 +152,8 @@ def test_project_lifecycle(self, hub):
                 print("5. Skipping command execution - project not ready")
 
             # 3. Stop and delete the project
-            print("6. Stopping project...")
-            hub.projects.stop(project_id)
-            print("   ✓ Project stop command sent")
-            time.sleep(3)  # Wait for process to terminate
-            print("   ✓ Waited for project to stop")
-
-            print("7. Deleting project...")
-            delete_result = hub.projects.delete(project_id)
-            print(f"   ✓ Delete result: {delete_result}")
+            print("6. Stopping and deleting project...")
+            cleanup_project(hub, project_id)
 
             # 4. Verify project is marked as deleted in database
             print("8. Verifying project is marked as deleted...")
@@ -185,15 +168,9 @@ def test_project_lifecycle(self, hub):
 
         except Exception as e:
             # Cleanup: attempt to stop and delete project if test fails
-            print(f"\n❌ Test failed: {e}")
+            print(f"\nTest failed: {e}")
             try:
-                print("Attempting cleanup: stopping then deleting project...")
-                hub.projects.stop(project_id)
-                print("✓ Project stop command sent")
-                time.sleep(3)  # Wait for process to terminate
-                print("✓ Waited for project to stop")
-                hub.projects.delete(project_id)
-                print("✓ Project deleted")
+                cleanup_project(hub, project_id)
             except Exception as cleanup_error:
-                print(f"❌ Cleanup failed: {cleanup_error}")
+                print(f"Cleanup failed: {cleanup_error}")
             raise e