Module Publishing Capstone - Grading Rubric

Total Points: 100

1. Module Structure & Code Quality (25 points)

File Structure (10 points)

Code Quality (15 points)

2. Variables & Validation (20 points)

Variable Definitions (12 points)

Input Validation (8 points)

Example of good validation:

variable "instance_type" {
  type    = string
  default = "t3.micro"

  validation {
    condition     = can(regex("^t[23]\\.(micro|small|medium)$", var.instance_type))
    error_message = "Instance type must be t2 or t3, size micro/small/medium (sandbox constraint)."
  }
}

3. Resources & Outputs (20 points)

Resources (12 points)

Outputs (8 points)

Example of good outputs:

output "instance_id" {
  description = "The ID of the EC2 instance"
  value       = aws_instance.this.id
}

output "public_ip" {
  description = "The public IP address of the instance (null if no public IP)"
  value       = aws_instance.this.public_ip
}

output "security_group_id" {
  description = "The ID of the security group attached to the instance"
  value       = aws_security_group.this.id
}

4. Documentation (15 points)

README.md (15 points)

Example README structure:

# terraform-aws-ec2-webserver

Creates an EC2 instance configured as a web server with security group.

## Usage

​```hcl
module "webserver" {
  source  = "username/ec2-webserver/aws"
  version = "1.0.0"

  instance_name    = "my-webserver"
  allowed_ssh_cidr = "10.0.0.0/8"
}
​```

## Requirements

| Name | Version |
|------|---------|
| terraform | >= 1.5.0 |
| aws | >= 5.0.0 |

## Inputs

| Name | Description | Type | Default | Required |
|------|-------------|------|---------|:--------:|
| instance_name | Name tag for the EC2 instance | string | n/a | yes |
| ... | ... | ... | ... | ... |

## Outputs

| Name | Description |
|------|-------------|
| instance_id | The ID of the EC2 instance |
| ... | ... |

5. Tests (15 points)

Test Coverage (15 points)

Good test coverage includes:

1. Resource creation test - Verify primary resource is created with expected attributes
2. Configuration test - Verify optional settings work (e.g., versioning enabled)
3. Tagging test - Verify required tags are present
4. Validation test (bonus) - Verify bad input is rejected

Example test file:

# tests/basic.tftest.hcl

variables {
  instance_name    = "test-instance"
  allowed_ssh_cidr = "10.0.0.0/8"
}

run "instance_is_created" {
  command = plan

  assert {
    condition     = aws_instance.this.instance_type == "t3.micro"
    error_message = "Instance should use t3.micro by default"
  }
}

run "security_group_allows_http" {
  command = plan

  assert {
    condition     = contains([for rule in aws_security_group.this.ingress : rule.from_port], 80)
    error_message = "Security group should allow HTTP on port 80"
  }
}

run "instance_has_name_tag" {
  command = plan

  assert {
    condition     = aws_instance.this.tags["Name"] == "test-instance"
    error_message = "Instance should have Name tag matching instance_name variable"
  }
}

6. Registry Publication (5 points)

Bonus Points (up to 10 extra)

Grading Notes

Automatic Failures (0 points for category)

• Repository name wrong: Module Structure = 0 (registry won't accept)
• terraform validate fails: Code Quality = 0
• No tests: Tests = 0
• Not published to registry: Publication = 0

Partial Credit

• Missing 1 of 4 required variables: -5 points
• Missing 1 of 3 required outputs: -3 points
• Tests exist but 1 fails: -5 points
• terraform-docs used but README incomplete: -5 points

Common Deductions

Submission Checklist

Before submitting, verify:

• Repository name matches terraform-aws-<n> pattern
• terraform fmt passes
• terraform validate passes
• terraform test shows all tests passing
• README.md exists with usage example
• Version tag v1.0.0 pushed to GitHub
• Module visible at registry.terraform.io
• SUBMISSION.md created with:
  • GitHub repo URL
  • Registry URL
  • Brief write-up

Grade Scale