feat: infracost integration (#118)

.github/workflows/build.yml

@@ -27,8 +27,8 @@ jobs:
         run: make vet
       - name: Setup provider mirror for tests
         run: ./hacks/setup_mirror.sh
-      - name: Install terragrunt for tests
-        run: make install-terragrunt
+      - name: Install test dependencies
+        run: make install-terragrunt install-infracost
       - name: Tests
         run: make test
   release-please:

Makefile

@@ -53,3 +53,10 @@ install-terragrunt:
 	mkdir -p ~/.local/bin
 	curl -L https://github.com/gruntwork-io/terragrunt/releases/download/v0.60.0/terragrunt_linux_amd64 -o ~/.local/bin/terragrunt
 	chmod +x ~/.local/bin/terragrunt
+
+.PHONY: install-infracost
+install-infracost:
+	mkdir -p ~/.local/bin
+	curl -L https://github.com/infracost/infracost/releases/download/v0.10.38/infracost-linux-amd64.tar.gz | tar -zxf -
+	mv infracost-linux-amd64 ~/.local/bin/infracost
+	chmod +x ~/.local/bin/infracost

README.md

@@ -9,6 +9,7 @@ A terminal user interface for terraform power users.
 * Supports terraform, tofu and terragrunt
 * Supports terragrunt dependencies
 * Supports workspaces
+* Calculate costs using infracost
 * Automatically loads workspace variable files
 * Backend agnostic (s3, cloud, etc)
 
@@ -128,6 +129,7 @@ Press `w` to go to the workspaces page.
 |`a`|Run `terraform apply`|✓|
 |`d`|Run `terraform apply -destroy`|✓|
 |`C`|Run `terraform workspace select`|✗|
+|`$`|Run `infracost breakdown`|✓|
 
 ### State
 
@@ -291,6 +293,18 @@ A task can be canceled at any stage. If it is `running` then the current terrafo
 
 When a workspace is loaded into Pug for the first time, a task is created to invoke `terraform state pull`, which retrieves workspace's state, and then the state is loaded into Pug. The task is also triggered after any task that alters the state, such as an apply or moving a resource in the state.
 
+## Infracost integration
+
+NOTE: Requires `infracost` to be installed on your machine, along with configured API key.
+
+Pug integrates with infracost to provide cost estimation. Select workspaces on the workspace page and press `$` to run calculate their costs:
+
+![Infracost output screenshot](./demo/infracost_output.png)
+
+Once the task has finished, the costs are visible on the workspaces page:
+
+![Worksapces with costs screenshot](./demo/workspaces_with_cost.png)
+
 ## Tofu support
 
 To use tofu, set `--program=tofu`. Ensure it is installed first.

demo/do_cost_money/modules/a/dev.tfvars

@@ -0,0 +1 @@
+instance_type = "n1-standard-96"

demo/do_cost_money/modules/a/main.tf

@@ -0,0 +1,59 @@
+terraform {
+  backend "local" {}
+}
+
+# Configure the AWS Provider
+provider "google" {
+  region = "us-east-1"
+}
+
+resource "google_compute_instance" "default" {
+  name         = "my-instance"
+  machine_type = var.instance_type
+  zone         = "us-central1-a"
+
+  tags = ["foo", "bar"]
+
+  boot_disk {
+    initialize_params {
+      image = "debian-cloud/debian-11"
+      labels = {
+        my_label = "value"
+      }
+    }
+  }
+
+  // Local SSD disk
+  scratch_disk {
+    interface = "NVME"
+  }
+
+  network_interface {
+    network = "default"
+
+    access_config {
+      // Ephemeral public IP
+    }
+  }
+
+  metadata = {
+    foo = "bar"
+  }
+
+  metadata_startup_script = "echo hi > /test.txt"
+
+  service_account {
+    # Google recommends custom service accounts that have cloud-platform scope and permissions granted via IAM Roles.
+    email  = google_service_account.default.email
+    scopes = ["cloud-platform"]
+  }
+}
+
+resource "google_service_account" "default" {
+  account_id   = "my-custom-sa"
+  display_name = "Custom SA for VM Instance"
+}
+
+variable "instance_type" {
+  default = "n2-standard-2"
+}

demo/do_cost_money/modules/b/main.tf

@@ -0,0 +1,59 @@
+terraform {
+  backend "local" {}
+}
+
+# Configure the AWS Provider
+provider "google" {
+  region = "us-east-1"
+}
+
+resource "google_compute_instance" "default" {
+  name         = "my-instance"
+  machine_type = var.instance_type
+  zone         = "us-central1-a"
+
+  tags = ["foo", "bar"]
+
+  boot_disk {
+    initialize_params {
+      image = "debian-cloud/debian-11"
+      labels = {
+        my_label = "value"
+      }
+    }
+  }
+
+  // Local SSD disk
+  scratch_disk {
+    interface = "NVME"
+  }
+
+  network_interface {
+    network = "default"
+
+    access_config {
+      // Ephemeral public IP
+    }
+  }
+
+  metadata = {
+    foo = "bar"
+  }
+
+  metadata_startup_script = "echo hi > /test.txt"
+
+  service_account {
+    # Google recommends custom service accounts that have cloud-platform scope and permissions granted via IAM Roles.
+    email  = google_service_account.default.email
+    scopes = ["cloud-platform"]
+  }
+}
+
+resource "google_service_account" "default" {
+  account_id   = "my-custom-sa"
+  display_name = "Custom SA for VM Instance"
+}
+
+variable "instance_type" {
+  default = "n2-standard-2"
+}

demo/do_cost_money/modules/c/main.tf

@@ -0,0 +1,59 @@
+terraform {
+  backend "local" {}
+}
+
+# Configure the AWS Provider
+provider "google" {
+  region = "us-east-1"
+}
+
+resource "google_compute_instance" "default" {
+  name         = "my-instance"
+  machine_type = var.instance_type
+  zone         = "us-central1-a"
+
+  tags = ["foo", "bar"]
+
+  boot_disk {
+    initialize_params {
+      image = "debian-cloud/debian-11"
+      labels = {
+        my_label = "value"
+      }
+    }
+  }
+
+  // Local SSD disk
+  scratch_disk {
+    interface = "NVME"
+  }
+
+  network_interface {
+    network = "default"
+
+    access_config {
+      // Ephemeral public IP
+    }
+  }
+
+  metadata = {
+    foo = "bar"
+  }
+
+  metadata_startup_script = "echo hi > /test.txt"
+
+  service_account {
+    # Google recommends custom service accounts that have cloud-platform scope and permissions granted via IAM Roles.
+    email  = google_service_account.default.email
+    scopes = ["cloud-platform"]
+  }
+}
+
+resource "google_service_account" "default" {
+  account_id   = "my-custom-sa"
+  display_name = "Custom SA for VM Instance"
+}
+
+variable "instance_type" {
+  default = "n2-standard-2"
+}