Implementation of project resource (#15)

Author: AlexejPenner

.gitignore

@@ -24,3 +24,10 @@ go.work.sum
 # env file
 .env
 .aider*
+
+# IDE specific files
+.idea/
+
+#Example
+*.tfstate
+*.tfvars

examples/project_creation/README.md

@@ -0,0 +1,67 @@
+# ZenML Project Example
+
+This example demonstrates how to create a ZenML project using the Terraform provider.
+
+## Authentication Options
+
+You have two options for authentication:
+
+### Option 1: API Key (Recommended)
+Use a service account API key. This is recommended for long-term automation.
+
+```bash
+# Set environment variables
+export ZENML_SERVER_URL="https://your-zenml-server.com"
+export ZENML_API_KEY="your-api-key"
+```
+
+Or use the tfvars file:
+```hcl
+zenml_server_url = "https://your-zenml-server.com"
+zenml_api_key    = "your-api-key"
+```
+
+### Option 2: API Token
+Use a JWT token directly. Note that tokens expire and are not recommended for automation.
+
+```bash
+# Set environment variables
+export ZENML_SERVER_URL="https://your-zenml-server.com"
+export ZENML_API_TOKEN="eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
+```
+
+Or use the tfvars file:
+```hcl
+zenml_server_url = "https://your-zenml-server.com"
+zenml_api_token  = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
+```
+
+## Usage
+
+1. Copy the example tfvars file:
+   ```bash
+   cp terraform.tfvars.example terraform.tfvars
+   ```
+
+2. Edit `terraform.tfvars` with your actual values:
+   - Update `zenml_server_url` with your ZenML server URL
+   - Add either `zenml_api_key` OR `zenml_api_token` (not both)
+   - Customize the project settings
+
+3. Run Terraform:
+   ```bash
+   terraform init
+   terraform plan
+   terraform apply
+   ```
+
+## Troubleshooting
+
+- **401 Authentication Error**: 
+  - If using JWT token, make sure it's not expired and you're using `zenml_api_token`
+  - If using API key, make sure it's valid and you're using `zenml_api_key`
+  - Don't use both `api_key` and `api_token` at the same time
+
+- **JWT Token Format Error**: 
+  - Make sure JWT tokens start with `eyJ` and are complete
+  - Use `zenml_api_token` for JWT tokens, not `zenml_api_key`

examples/project_creation/terraform.tfvars.example

@@ -0,0 +1,14 @@
+# ZenML Server Configuration
+zenml_server_url = "https://your-zenml-server.com"
+
+# Authentication - Use EITHER api_key OR api_token, not both
+# Option 1: Use API Key (recommended for service accounts)
+zenml_api_key = "your-api-key-here"
+
+# Option 2: Use API Token (JWT token - starts with eyJ)
+# zenml_api_token = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
+
+# Project Configuration
+project_name         = "my-terraform-project"
+project_display_name = "My Terraform Project"
+project_description  = "A project managed by Terraform"

examples/project_creation/test_project.tf

@@ -0,0 +1,27 @@
+terraform {
+  required_providers {
+    zenml = {
+      source = "zenml/zenml"
+    }
+  }
+}
+
+provider "zenml" {
+  server_url = var.zenml_server_url
+  api_key    = var.zenml_api_key
+  api_token  = var.zenml_api_token
+}
+
+resource "zenml_project" "test_project" {
+  name         = var.project_name
+  display_name = var.project_display_name
+  description  = var.project_description
+}
+
+output "project_id" {
+  value = zenml_project.test_project.id
+}
+
+output "project_created" {
+  value = zenml_project.test_project.created
+}

examples/project_creation/variables.tf

@@ -0,0 +1,37 @@
+variable "zenml_server_url" {
+  description = "The URL of your ZenML server"
+  type        = string
+  default     = "https://your-zenml-server.com"
+}
+
+variable "zenml_api_key" {
+  description = "Your ZenML API key (for service accounts)"
+  type        = string
+  sensitive   = true
+  default     = null
+}
+
+variable "zenml_api_token" {
+  description = "Your ZenML API token (JWT token)"
+  type        = string
+  sensitive   = true
+  default     = null
+}
+
+variable "project_name" {
+  description = "The name of the project to create"
+  type        = string
+  default     = "my-terraform-project"
+}
+
+variable "project_display_name" {
+  description = "The display name of the project"
+  type        = string
+  default     = "My Terraform Project"
+}
+
+variable "project_description" {
+  description = "The description of the project"
+  type        = string
+  default     = "A project managed by Terraform"
+}

internal/provider/client.go

@@ -553,3 +553,136 @@ func (c *Client) GetCurrentUser(ctx context.Context) (*UserResponse, error) {
 	}
 	return &result, nil
 }
+
+// Project operations
+func (c *Client) CreateProject(ctx context.Context, project ProjectRequest) (*ProjectResponse, error) {
+	endpoint := "/api/v1/projects"
+	resp, _, err := c.doRequest(ctx, "POST", endpoint, project)
+	if err != nil {
+		return nil, err
+	}
+	defer resp.Body.Close()
+
+	var result ProjectResponse
+	if err := json.NewDecoder(resp.Body).Decode(&result); err != nil {
+		return nil, fmt.Errorf("error decoding project response: %v", err)
+	}
+	return &result, nil
+}
+
+func (c *Client) GetProject(ctx context.Context, nameOrID string) (*ProjectResponse, error) {
+	endpoint := fmt.Sprintf("/api/v1/projects/%s", nameOrID)
+	resp, status, err := c.doRequest(ctx, "GET", endpoint, nil)
+	if err != nil {
+		if status == 404 {
+			return nil, fmt.Errorf("404")
+		}
+		return nil, err
+	}
+	defer resp.Body.Close()
+
+	var result ProjectResponse
+	if err := json.NewDecoder(resp.Body).Decode(&result); err != nil {
+		return nil, fmt.Errorf("error decoding project response: %v", err)
+	}
+	return &result, nil
+}
+
+func (c *Client) UpdateProject(ctx context.Context, nameOrID string, project ProjectUpdate) (*ProjectResponse, error) {
+	endpoint := fmt.Sprintf("/api/v1/projects/%s", nameOrID)
+	resp, _, err := c.doRequest(ctx, "PUT", endpoint, project)
+	if err != nil {
+		return nil, err
+	}
+	defer resp.Body.Close()
+
+	var result ProjectResponse
+	if err := json.NewDecoder(resp.Body).Decode(&result); err != nil {
+		return nil, fmt.Errorf("error decoding project response: %v", err)
+	}
+	return &result, nil
+}
+
+func (c *Client) DeleteProject(ctx context.Context, nameOrID string) error {
+	endpoint := fmt.Sprintf("/api/v1/projects/%s", nameOrID)
+	resp, status, err := c.doRequest(ctx, "DELETE", endpoint, nil)
+	if err != nil {
+		if status == 404 {
+			return fmt.Errorf("404")
+		}
+		return err
+	}
+	defer resp.Body.Close()
+	return nil
+}
+
+func (c *Client) ListProjects(ctx context.Context, params ProjectFilterParams) (*PageProjectResponse, error) {
+	endpoint := "/api/v1/projects"
+	
+	// Build query parameters
+	query := make(url.Values)
+	if params.Hydrate != nil {
+		query.Set("hydrate", fmt.Sprintf("%t", *params.Hydrate))
+	}
+	if params.SortBy != nil {
+		query.Set("sort_by", *params.SortBy)
+	}
+	if params.LogicalOperator != nil {
+		query.Set("logical_operator", string(*params.LogicalOperator))
+	}
+	if params.Page != nil {
+		query.Set("page", fmt.Sprintf("%d", *params.Page))
+	}
+	if params.Size != nil {
+		query.Set("size", fmt.Sprintf("%d", *params.Size))
+	}
+	if params.ID != nil {
+		query.Set("id", *params.ID)
+	}
+	if params.Created != nil {
+		query.Set("created", *params.Created)
+	}
+	if params.Updated != nil {
+		query.Set("updated", *params.Updated)
+	}
+	if params.Name != nil {
+		query.Set("name", *params.Name)
+	}
+	if params.DisplayName != nil {
+		query.Set("display_name", *params.DisplayName)
+	}
+
+	if len(query) > 0 {
+		endpoint += "?" + query.Encode()
+	}
+
+	resp, _, err := c.doRequest(ctx, "GET", endpoint, nil)
+	if err != nil {
+		return nil, err
+	}
+	defer resp.Body.Close()
+
+	var result PageProjectResponse
+	if err := json.NewDecoder(resp.Body).Decode(&result); err != nil {
+		return nil, fmt.Errorf("error decoding projects response: %v", err)
+	}
+	return &result, nil
+}
+
+func (c *Client) GetProjectStatistics(ctx context.Context, nameOrID string) (*ProjectStatistics, error) {
+	endpoint := fmt.Sprintf("/api/v1/projects/%s/statistics", nameOrID)
+	resp, status, err := c.doRequest(ctx, "GET", endpoint, nil)
+	if err != nil {
+		if status == 404 {
+			return nil, fmt.Errorf("404")
+		}
+		return nil, err
+	}
+	defer resp.Body.Close()
+
+	var result ProjectStatistics
+	if err := json.NewDecoder(resp.Body).Decode(&result); err != nil {
+		return nil, fmt.Errorf("error decoding project statistics response: %v", err)
+	}
+	return &result, nil
+}

internal/provider/models.go

@@ -244,12 +244,71 @@ type UserMetadata struct {
 	OverviewTourDone         bool     `json:"overview_tour_done"`
 }
 
-// ProjectResponse represents a project response from the API
-type ProjectResponse struct {
-	ID          string `json:"id"`
+// ProjectRequest represents a request to create a new project
+type ProjectRequest struct {
 	Name        string `json:"name"`
-	DisplayName string `json:"display_name"`
+	DisplayName string `json:"display_name,omitempty"`
 	Description string `json:"description,omitempty"`
+}
+
+// ProjectResponse represents a project response from the API
+type ProjectResponse struct {
+	ID       string                   `json:"id"`
+	Name     string                   `json:"name"`
+	Body     *ProjectResponseBody     `json:"body,omitempty"`
+	Metadata *ProjectResponseMetadata `json:"metadata,omitempty"`
+}
+
+type ProjectResponseBody struct {
 	Created     string `json:"created"`
 	Updated     string `json:"updated"`
+	DisplayName string `json:"display_name"`
+}
+
+type ProjectResponseMetadata struct {
+	Description string `json:"description,omitempty"`
+}
+
+// ProjectUpdate represents an update to an existing project
+type ProjectUpdate struct {
+	Name        *string `json:"name,omitempty"`
+	DisplayName *string `json:"display_name,omitempty"`
+	Description *string `json:"description,omitempty"`
+}
+
+// PageProjectResponse represents a paginated response of projects
+type PageProjectResponse struct {
+	Index      int               `json:"index"`
+	MaxSize    int               `json:"max_size"`
+	TotalPages int               `json:"total_pages"`
+	Total      int               `json:"total"`
+	Items      []ProjectResponse `json:"items"`
+}
+
+// ProjectStatistics represents project statistics
+type ProjectStatistics struct {
+	Pipelines int `json:"pipelines"`
+	Runs      int `json:"runs"`
+}
+
+// LogicalOperator represents logical operators for filtering
+type LogicalOperator string
+
+const (
+	LogicalOperatorAnd LogicalOperator = "and"
+	LogicalOperatorOr  LogicalOperator = "or"
+)
+
+// ProjectFilterParams represents parameters for filtering projects
+type ProjectFilterParams struct {
+	Hydrate         *bool            `json:"hydrate,omitempty"`
+	SortBy          *string          `json:"sort_by,omitempty"`
+	LogicalOperator *LogicalOperator `json:"logical_operator,omitempty"`
+	Page            *int             `json:"page,omitempty"`
+	Size            *int             `json:"size,omitempty"`
+	ID              *string          `json:"id,omitempty"`
+	Created         *string          `json:"created,omitempty"`
+	Updated         *string          `json:"updated,omitempty"`
+	Name            *string          `json:"name,omitempty"`
+	DisplayName     *string          `json:"display_name,omitempty"`
 }

internal/provider/provider.go

@@ -40,6 +40,7 @@ func Provider() *schema.Provider {
 			"zenml_stack":             resourceStack(),
 			"zenml_stack_component":   resourceStackComponent(),
 			"zenml_service_connector": resourceServiceConnector(),
+			"zenml_project":           resourceProject(),
 		},
 		DataSourcesMap: map[string]*schema.Resource{
 			"zenml_server":            dataSourceServer(),