Add tofu config + initial tests

Author: wtripp180901

requirements.txt

@@ -11,3 +11,4 @@ prometheus_client==0.20.0
 tzdata==2024.1
 psycopg2-binary==2.9.9
 whitenoise==6.9.0
+tofupy==1.1.1

tofu/.gitignore

@@ -0,0 +1,39 @@
+tests/__pycache__/**
+
+# Local .terraform directories
+.terraform/
+
+# .tfstate files
+*.tfstate
+*.tfstate.*
+
+# Crash log files
+crash.log
+crash.*.log
+
+# Exclude all .tfvars files, which are likely to contain sensitive data, such as
+# password, private keys, and other secrets. These should not be part of version
+# control as they are data points which are potentially sensitive and subject
+# to change depending on the environment.
+*.tfvars
+*.tfvars.json
+
+# Ignore override files as they are usually used to override resources locally and so
+# are not checked in
+override.tf
+override.tf.json
+*_override.tf
+*_override.tf.json
+
+# Ignore transient lock info files created by terraform apply
+.terraform.tfstate.lock.info
+
+# Include override files you do wish to add to version control using negated pattern
+# !example_override.tf
+
+# Include tfplan files to ignore the plan output of command: terraform plan -out=tfplan
+# example: *tfplan*
+
+# Ignore CLI configuration files
+.terraformrc
+terraform.rc

tofu/example-config.tfvars

@@ -0,0 +1,62 @@
+# coral_uri = "http://credits.apps.<azimuth-domain>"
+# auth_token = Get bearer token with `curl -X POST -H "Content-Type: application/json" -d \
+#    "{
+#        \"username\": \"admin\", 
+#        \"password\": \"$TEST_PASSWORD\"
+#    }" \ http://credits.apps.<azimuth-domain>/api_auth_token/
+
+resource_provider_name     = "Test Provider"
+resource_provider_email    = "[email protected]"
+resource_provider_info_url = "https://www.google.com"
+
+accounts = [
+  {
+    name                 = "TestAccount1"
+    email                = "[email protected]"
+    openstack_project_id = "c2eced313b324cdb8e670e6e30bf387d"
+  },
+  {
+    name                 = "TestAccount2"
+    email                = "[email protected]"
+    openstack_project_id = "2fbf511968aa443e883a82283b0f0160"
+  }
+]
+
+allocations = {
+  Q1 = {
+    start_date = "2025-09-01-12:00:00"
+    end_date   = "2025-12-01-12:00:00"
+    projects = [
+      {
+        account_email = "[email protected]"
+        resources = {
+          VCPU    = 40000
+          MEMORY_MB  = 4423680
+          DISK_GB = 108000
+        }
+      },
+      {
+        account_email = "[email protected]"
+        resources = {
+          VCPU    = 20000
+          MEMORY_MB  = 2000000
+          DISK_GB = 200000
+        }
+      }
+    ]
+  }
+  Q2 = {
+    start_date = "2026-01-01-12:00:00"
+    end_date   = "2026-04-01-12:00:00"
+    projects = [
+      {
+        account_email = "[email protected]"
+        resources = {
+          VCPU    = 80000
+          MEMORY_MB  = 8000000
+          DISK_GB = 300000
+        }
+      }
+    ]
+  }
+}

tofu/main.tf

@@ -0,0 +1,36 @@
+terraform {
+  required_providers {
+    restapi = {
+      source  = "Mastercard/restapi"
+      version = "1.20.0"
+    }
+  }
+}
+
+provider "restapi" {
+  alias                 = "coral"
+  uri                   = var.coral_uri
+  debug                 = false
+  write_returns_object  = true
+  create_returns_object = true
+  id_attribute = "id"
+  headers = {
+    "Content-Type" = "application/json"
+    Authorization  = "Bearer ${var.auth_token}"
+  }
+}
+
+module "coral_tofu" {
+    source = "git::https://github.com/stackhpc/coral-credits-tofu.git?ref=main" #TODO: move to versioned release
+    
+    resource_provider_name = var.resource_provider_name
+    resource_provider_email = var.resource_provider_email
+    resource_provider_info_url = var.resource_provider_info_url
+    allocations = var.allocations
+    accounts = var.accounts
+    resource_classes = var.resource_classes
+
+    providers = {
+        restapi.coral = restapi.coral
+    }
+}

tofu/tests/tofu_tests.py

@@ -0,0 +1,99 @@
+import pytest
+from tofupy import Tofu
+import requests
+import os
+import time
+
+coral_uri = os.environ.get("TF_VAR_coral_uri")
+headers = {"Authorization": "Bearer "+os.environ.get("TF_VAR_auth_token")}
+
+@pytest.fixture(scope="session")
+def terraform_rest_setup():
+    working_dir = os.path.join(os.path.dirname(__file__), "..")
+    var_file = os.path.join(working_dir, "example-config.tfvars")
+    tf = Tofu(cwd=working_dir)
+    tf.init()
+    tf.apply(extra_args=["--var-file="+var_file])
+    # add_consumers()
+    yield
+    tf.apply(extra_args=["--var-file="+var_file],destroy=True)
+
+def api_get_request(resource):
+    return requests.get(coral_uri+"/"+resource,headers=headers).json()
+
+def contains_only(actual, expected):
+    return len(actual) == len(expected) and set(expected).issubset(actual)
+
+def test_resource_classes_created(terraform_rest_setup):
+    resp = api_get_request("resource_class")
+    created_resource_classes = [c["name"] for c in resp]
+
+    assert contains_only(created_resource_classes, ["DISK_GB", "MEMORY_MB", "VCPU"])
+
+def test_resource_provider_created(terraform_rest_setup):
+    providers = api_get_request("resource_provider")
+    provider_names = [p["name"] for p in providers]
+    
+    assert contains_only(provider_names, ["Test Provider"])
+
+def test_accounts_created(terraform_rest_setup):
+    accounts = api_get_request("account")
+    account_names = [a["name"] for a in accounts]
+
+    assert contains_only(account_names, ["TestAccount1","TestAccount2"])
+
+def test_rpas_created(terraform_rest_setup):
+    rpas = api_get_request("resource_provider_account")
+    accounts = api_get_request("account")
+    rpa_account_urls = [a["account"] for a in rpas]
+    account_urls = [a["url"] for a in accounts]
+    assert contains_only(rpa_account_urls, account_urls)
+
+def test_allocations_created(terraform_rest_setup):
+    allocations = api_get_request("allocation")
+    allocations_names = [a["name"] for a in allocations]
+
+    assert contains_only(allocations_names, ["Q1-0","Q1-1","Q2-0"])
+
+def test_allocation_user_mappings(terraform_rest_setup):
+    allocations = api_get_request("allocation")
+    q1_allocations = [a for a in allocations if a["name"][:2] == "Q1"]
+    q2_allocations = [a for a in allocations if a["name"][:2] == "Q2"]
+
+    accounts = api_get_request("account")
+    account_urls = {a["name"]: a["url"] for a in accounts}
+
+    q1_allocated_accounts = [a["account"] for a in q1_allocations]
+    q2_allocated_accounts = [a["account"] for a in q2_allocations]
+
+    assert contains_only(q1_allocated_accounts, [account_urls["TestAccount1"],account_urls["TestAccount2"]])
+    assert contains_only(q2_allocated_accounts, [account_urls["TestAccount1"]])
+
+def test_allocation_date_mappings(terraform_rest_setup):
+    allocations = api_get_request("allocation")
+    q1_allocations = [a for a in allocations if a["name"][:2] == "Q1"]
+    q2_allocations = [a for a in allocations if a["name"][:2] == "Q2"]
+
+    q1_allocation_starts = [a["start"] for a in q1_allocations]
+    q2_allocation_starts = [a["start"] for a in q2_allocations]
+
+    assert len(set(q1_allocation_starts)) == 1
+    assert len(q2_allocation_starts) == 1
+    assert q1_allocation_starts[0] != q2_allocation_starts[0]
+
+def to_resource_map(allocation_resources):
+    return {a["resource_class"]["name"] : a["resource_hours"] for a in allocation_resources}
+
+def test_only_allocation_resources_returned(terraform_rest_setup):
+    allocation_id = api_get_request("allocation")[0]["id"]
+    assert len(api_get_request("allocation/"+str(allocation_id)+"/resources")) == 3
+
+def test_resource_allocations_created(terraform_rest_setup):
+    allocations = api_get_request("allocation")
+    allocation_resources = {
+        a["name"]: to_resource_map(api_get_request("allocation/"+str(a["id"])+"/resources"))
+        for a in allocations
+    }
+    assert allocation_resources["Q1-0"] == {"VCPU": 40000, "MEMORY_MB": 4423680, "DISK_GB": 108000}
+    assert allocation_resources["Q1-1"] == {"VCPU": 20000, "MEMORY_MB": 2000000, "DISK_GB": 200000}
+    assert allocation_resources["Q2-0"] == {"VCPU": 80000, "MEMORY_MB": 8000000, "DISK_GB": 300000}

tofu/variables.tf

@@ -0,0 +1,32 @@
+variable "coral_uri" {
+  type = string
+}
+
+variable "auth_token" {
+  type = string
+}
+
+variable "resource_provider_name" {
+  type = string
+}
+
+variable "resource_provider_email" {
+  type = string
+}
+
+variable "resource_provider_info_url" {
+  type = string
+}
+
+variable "allocations" {
+  type = map(any)
+}
+
+variable "accounts" {
+  type = list(map(string))
+}
+
+variable "resource_classes" {
+  type    = list(string)
+  default = ["VCPU", "MEMORY_MB", "DISK_GB"]
+}