CRUD operation for Project of Python TFE

Author: KshitijaChoudhari

examples/project_integration_test_example.py

@@ -91,9 +91,11 @@ def test_list_projects_integration(integration_client):
 
         if project_list:
             project = project_list[0]
-            assert hasattr(project, 'id'), "Project should have an ID"
-            assert hasattr(project, 'name'), "Project should have a name"
-            assert hasattr(project, 'organization'), "Project should have an organization"
+            assert hasattr(project, "id"), "Project should have an ID"
+            assert hasattr(project, "name"), "Project should have a name"
+            assert hasattr(project, "organization"), (
+                "Project should have an organization"
+            )
             print(f"📋 Example project: {project.name} (ID: {project.id})")
         else:
             print("📋 No projects found - this is normal for a new organization")
@@ -123,9 +125,15 @@ def test_project_crud_integration(integration_client):
         print(f"🔨 Creating project: {test_name}")
         created_project = projects.create(org, test_name)
 
-        assert created_project.name == test_name, f"Expected name {test_name}, got {created_project.name}"
-        assert created_project.organization == org, f"Expected org {org}, got {created_project.organization}"
-        assert created_project.id.startswith("prj-"), f"Project ID should start with 'prj-', got {created_project.id}"
+        assert created_project.name == test_name, (
+            f"Expected name {test_name}, got {created_project.name}"
+        )
+        assert created_project.organization == org, (
+            f"Expected org {org}, got {created_project.organization}"
+        )
+        assert created_project.id.startswith("prj-"), (
+            f"Project ID should start with 'prj-', got {created_project.id}"
+        )
 
         project_id = created_project.id
         print(f"✅ Created project: {project_id}")
@@ -134,16 +142,24 @@ def test_project_crud_integration(integration_client):
         print(f"📖 Reading project: {project_id}")
         read_project = projects.read(project_id)
 
-        assert read_project.id == project_id, f"Expected ID {project_id}, got {read_project.id}"
-        assert read_project.name == test_name, f"Expected name {test_name}, got {read_project.name}"
+        assert read_project.id == project_id, (
+            f"Expected ID {project_id}, got {read_project.id}"
+        )
+        assert read_project.name == test_name, (
+            f"Expected name {test_name}, got {read_project.name}"
+        )
         print(f"✅ Successfully read project: {read_project.name}")
 
         # UPDATE - Test updating the project name
         print(f"✏️  Updating project name to: {updated_name}")
         updated_project = projects.update(project_id, updated_name)
 
-        assert updated_project.id == project_id, f"Project ID should remain {project_id}"
-        assert updated_project.name == updated_name, f"Expected updated name {updated_name}, got {updated_project.name}"
+        assert updated_project.id == project_id, (
+            f"Project ID should remain {project_id}"
+        )
+        assert updated_project.name == updated_name, (
+            f"Expected updated name {updated_name}, got {updated_project.name}"
+        )
         print(f"✅ Successfully updated project: {updated_project.name}")
 
     except Exception as e:
@@ -158,7 +174,9 @@ def test_project_crud_integration(integration_client):
                 print("✅ Test project deleted successfully")
             except Exception as e:
                 print(f"❌ Warning: Failed to clean up project {project_id}: {e}")
-                print("   You may need to manually delete this project in HCP Terraform")
+                print(
+                    "   You may need to manually delete this project in HCP Terraform"
+                )
 
 
 def test_error_handling_integration(integration_client):
@@ -172,7 +190,9 @@ def test_error_handling_integration(integration_client):
         projects.read(fake_project_id)
         pytest.fail("Should have raised an exception for non-existent project")
     except Exception as e:
-        print(f"✅ Correctly handled error for non-existent project: {type(e).__name__}")
+        print(
+            f"✅ Correctly handled error for non-existent project: {type(e).__name__}"
+        )
         # This should raise a NotFound or similar error
         assert "not found" in str(e).lower() or "404" in str(e)
 
@@ -197,7 +217,9 @@ def test_error_handling_integration(integration_client):
         sys.exit(1)
 
     print("🧪 Running integration tests directly...")
-    print("   For full pytest features, use: pytest examples/integration_test_example.py -v -s")
+    print(
+        "   For full pytest features, use: pytest examples/integration_test_example.py -v -s"
+    )
 
     # Simple direct execution
     pytest.main([__file__, "-v", "-s"])

src/tfe/resources/projects.py

@@ -23,14 +23,7 @@ def list(self, organization: str) -> Iterator[Project]:
     def create(self, organization: str, name: str) -> Project:
         """Create a new project in an organization"""
         path = f"/api/v2/organizations/{organization}/projects"
-        payload = {
-            "data": {
-                "type": "projects",
-                "attributes": {
-                    "name": name
-                }
-            }
-        }
+        payload = {"data": {"type": "projects", "attributes": {"name": name}}}
 
         # Use json_body parameter (correct parameter name)
         response = self.t.request("POST", path, json_body=payload)
@@ -40,7 +33,7 @@ def create(self, organization: str, name: str) -> Project:
         return Project(
             id=_safe_str(data.get("id")),
             name=_safe_str(attr.get("name")),
-            organization=organization
+            organization=organization,
         )
 
     def read(self, project_id: str) -> Project:
@@ -58,20 +51,14 @@ def read(self, project_id: str) -> Project:
         return Project(
             id=_safe_str(data.get("id")),
             name=_safe_str(attr.get("name")),
-            organization=organization
+            organization=organization,
         )
 
     def update(self, project_id: str, name: str) -> Project:
         """Update a project's name"""
         path = f"/api/v2/projects/{project_id}"
         payload = {
-            "data": {
-                "type": "projects",
-                "id": project_id,
-                "attributes": {
-                    "name": name
-                }
-            }
+            "data": {"type": "projects", "id": project_id, "attributes": {"name": name}}
         }
 
         # Use json_body parameter (correct parameter name)
@@ -87,7 +74,7 @@ def update(self, project_id: str, name: str) -> Project:
         return Project(
             id=_safe_str(data.get("id")),
             name=_safe_str(attr.get("name")),
-            organization=organization
+            organization=organization,
         )
 
     def delete(self, project_id: str) -> None:

tests/units/test_project.py

@@ -25,17 +25,13 @@ def test_list_projects_success(self):
             {
                 "id": "prj-123",
                 "type": "projects",
-                "attributes": {
-                    "name": "Test Project 1"
-                }
+                "attributes": {"name": "Test Project 1"},
             },
             {
                 "id": "prj-456",
                 "type": "projects",
-                "attributes": {
-                    "name": "Test Project 2"
-                }
-            }
+                "attributes": {"name": "Test Project 2"},
+            },
         ]
 
         # Mock the _list method to return our test data
@@ -74,9 +70,7 @@ def test_create_project_success(self):
             "data": {
                 "id": "prj-123",
                 "type": "projects",
-                "attributes": {
-                    "name": project_name
-                }
+                "attributes": {"name": project_name},
             }
         }
         self.mock_transport.request.return_value = mock_response
@@ -92,14 +86,11 @@ def test_create_project_success(self):
         # Verify API call
         expected_path = f"/api/v2/organizations/{organization}/projects"
         expected_payload = {
-            "data": {
-                "type": "projects",
-                "attributes": {
-                    "name": project_name
-                }
-            }
+            "data": {"type": "projects", "attributes": {"name": project_name}}
         }
-        self.mock_transport.request.assert_called_once_with("POST", expected_path, json_body=expected_payload)
+        self.mock_transport.request.assert_called_once_with(
+            "POST", expected_path, json_body=expected_payload
+        )
 
     def test_read_project_success(self):
         """Test successful project read"""
@@ -111,16 +102,8 @@ def test_read_project_success(self):
             "data": {
                 "id": project_id,
                 "type": "projects",
-                "attributes": {
-                    "name": "Test Project"
-                },
-                "relationships": {
-                    "organization": {
-                        "data": {
-                            "id": "test-org"
-                        }
-                    }
-                }
+                "attributes": {"name": "Test Project"},
+                "relationships": {"organization": {"data": {"id": "test-org"}}},
             }
         }
         self.mock_transport.request.return_value = mock_response
@@ -148,16 +131,8 @@ def test_update_project_success(self):
             "data": {
                 "id": project_id,
                 "type": "projects",
-                "attributes": {
-                    "name": new_name
-                },
-                "relationships": {
-                    "organization": {
-                        "data": {
-                            "id": "test-org"
-                        }
-                    }
-                }
+                "attributes": {"name": new_name},
+                "relationships": {"organization": {"data": {"id": "test-org"}}},
             }
         }
         self.mock_transport.request.return_value = mock_response
@@ -176,12 +151,12 @@ def test_update_project_success(self):
             "data": {
                 "type": "projects",
                 "id": project_id,
-                "attributes": {
-                    "name": new_name
-                }
+                "attributes": {"name": new_name},
             }
         }
-        self.mock_transport.request.assert_called_once_with("PATCH", expected_path, json_body=expected_payload)
+        self.mock_transport.request.assert_called_once_with(
+            "PATCH", expected_path, json_body=expected_payload
+        )
 
     def test_delete_project_success(self):
         """Test successful project deletion"""
@@ -236,9 +211,7 @@ def test_read_project_missing_organization(self):
             "data": {
                 "id": project_id,
                 "type": "projects",
-                "attributes": {
-                    "name": "Test Project"
-                }
+                "attributes": {"name": "Test Project"},
                 # No relationships field
             }
         }