feat: Add power and usb data source

jlec · jlec · commit cdd0ff827ec7 · 2023-04-22T10:51:09.000+01:00
diff --git a/.golangci.yml b/.golangci.yml
@@ -31,3 +31,8 @@ linters-settings:
     allow-trailing-comment: true
   lll:
     line-length: 128
+issues:
+  exclude-rules:
+    - path: 'internal/provider'
+      linters:
+        - dupl
diff --git a/Taskfile.yml b/Taskfile.yml
@@ -184,6 +184,7 @@ tasks:
   go-generate:
     desc: Generate GO docs and stuff
     cmds:
+      - go get github.com/hashicorp/terraform-plugin-docs/cmd/tfplugindocs
       - go generate ./...
 
   #############################################################################
diff --git a/docs/data-sources/nodeinfo.md b/docs/data-sources/nodeinfo.md
@@ -0,0 +1,24 @@
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "turing-pi-bmc_nodeinfo Data Source - terraform-provider-turing-pi-bmc"
+subcategory: ""
+description: |-
+  Turing PI NodeInfo Data Source
+---
+
+# turing-pi-bmc_nodeinfo (Data Source)
+
+Turing PI NodeInfo Data Source
+
+
+
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Read-Only
+
+- `id` (String) ID
+- `node1` (String) Information for Node 1
+- `node2` (String) Information for Node 2
+- `node3` (String) Information for Node 3
+- `node4` (String) Information for Node 4
diff --git a/docs/data-sources/power.md b/docs/data-sources/power.md
@@ -0,0 +1,24 @@
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "turing-pi-bmc_power Data Source - terraform-provider-turing-pi-bmc"
+subcategory: ""
+description: |-
+  Turing PI Power Data Source
+---
+
+# turing-pi-bmc_power (Data Source)
+
+Turing PI Power Data Source
+
+
+
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Read-Only
+
+- `id` (String) ID
+- `node1` (Number) Power state of Node 1
+- `node2` (Number) Power state of Node 2
+- `node3` (Number) Power state of Node 3
+- `node4` (Number) Power state of Node 4
diff --git a/docs/data-sources/usb.md b/docs/data-sources/usb.md
@@ -0,0 +1,22 @@
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "turing-pi-bmc_usb Data Source - terraform-provider-turing-pi-bmc"
+subcategory: ""
+description: |-
+  Turing PI Usb Data Source
+---
+
+# turing-pi-bmc_usb (Data Source)
+
+Turing PI Usb Data Source
+
+
+
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Read-Only
+
+- `id` (String) ID
+- `mode` (Number) USB mode
+- `node` (Number) Node using USB
diff --git a/docs/index.md b/docs/index.md
@@ -14,6 +14,8 @@ description: |-
 
 ```terraform
 terraform {
+  required_version = "~>1.4"
+
   required_providers {
     turing-pi-bmc = {
       source  = "jlec.de/dev/turing-pi-bmc"
diff --git a/examples/data-sources/power/data-source.tf b/examples/data-sources/power/data-source.tf
@@ -0,0 +1,22 @@
+
+terraform {
+  required_version = "~>1.4"
+
+  required_providers {
+    turing-pi-bmc = {
+      source  = "jlec.de/dev/turing-pi-bmc"
+      version = ">0"
+    }
+  }
+}
+
+provider "turing-pi-bmc" {
+  endpoint = "10.100.100.231"
+}
+
+data "turing-pi-bmc_power" "example" {
+}
+
+output "power" {
+  value = data.turing-pi-bmc_power.example
+}
diff --git a/examples/data-sources/usb/data-source.tf b/examples/data-sources/usb/data-source.tf
@@ -0,0 +1,22 @@
+
+terraform {
+  required_version = "~>1.4"
+
+  required_providers {
+    turing-pi-bmc = {
+      source  = "jlec.de/dev/turing-pi-bmc"
+      version = ">0"
+    }
+  }
+}
+
+provider "turing-pi-bmc" {
+  endpoint = "10.100.100.231"
+}
+
+data "turing-pi-bmc_usb" "example" {
+}
+
+output "usb" {
+  value = data.turing-pi-bmc_usb.example
+}
diff --git a/internal/api/model.go b/internal/api/model.go
@@ -20,3 +20,23 @@ type NodeInfo struct {
 type NodeInfoResponse struct {
 	Response []NodeInfo `json:"response"`
 }
+
+type Power struct {
+	Node1 int64 `json:"node1"`
+	Node2 int64 `json:"node2"`
+	Node3 int64 `json:"node3"`
+	Node4 int64 `json:"node4"`
+}
+
+type PowerResponse struct {
+	Response []Power `json:"response"`
+}
+
+type Usb struct {
+	Mode int64 `json:"mode"`
+	Node int64 `json:"node"`
+}
+
+type UsbResponse struct {
+	Response []Usb `json:"response"`
+}
diff --git a/internal/api/power.go b/internal/api/power.go
@@ -0,0 +1,29 @@
+package turingpi
+
+import (
+	"encoding/json"
+	"fmt"
+	"net/http"
+)
+
+// GetPower - Returns Turing Pi BMC SD card status.
+func (c *Client) GetPower() (Power, error) {
+	req, err := http.NewRequest(http.MethodGet, fmt.Sprintf("%s?opt=get&type=power", c.ApiURI), nil)
+	if err != nil {
+		return Power{}, err
+	}
+
+	body, err := c.doRequest(req)
+	if err != nil {
+		return Power{}, err
+	}
+
+	sdCardResponse := PowerResponse{}
+	err = json.Unmarshal(body, &sdCardResponse)
+
+	if err != nil {
+		return Power{}, err
+	}
+
+	return sdCardResponse.Response[0], nil
+}
diff --git a/internal/api/usb.go b/internal/api/usb.go
@@ -0,0 +1,29 @@
+package turingpi
+
+import (
+	"encoding/json"
+	"fmt"
+	"net/http"
+)
+
+// GetUsb - Returns Turing Pi BMC SD card status.
+func (c *Client) GetUsb() (Usb, error) {
+	req, err := http.NewRequest(http.MethodGet, fmt.Sprintf("%s?opt=get&type=usb", c.ApiURI), nil)
+	if err != nil {
+		return Usb{}, err
+	}
+
+	body, err := c.doRequest(req)
+	if err != nil {
+		return Usb{}, err
+	}
+
+	sdCardResponse := UsbResponse{}
+	err = json.Unmarshal(body, &sdCardResponse)
+
+	if err != nil {
+		return Usb{}, err
+	}
+
+	return sdCardResponse.Response[0], nil
+}
diff --git a/internal/provider/nodeinfo_data_source.go b/internal/provider/nodeinfo_data_source.go
@@ -18,10 +18,6 @@ var (
 	_ datasource.DataSourceWithConfigure = &nodeInfoDataSource{}
 )
 
-func NewnodeInfoDataSource() datasource.DataSource {
-	return &nodeInfoDataSource{}
-}
-
 // NewNodeInfoDataSource is a helper function to simplify the provider implementation.
 func NewNodeInfoDataSource() datasource.DataSource {
 	return &nodeInfoDataSource{}
diff --git a/internal/provider/power_data_source.go b/internal/provider/power_data_source.go
@@ -0,0 +1,125 @@
+package provider
+
+import (
+	"context"
+	"fmt"
+
+	"github.com/hashicorp/terraform-plugin-framework/datasource"
+	"github.com/hashicorp/terraform-plugin-framework/datasource/schema"
+	"github.com/hashicorp/terraform-plugin-framework/types"
+	"github.com/hashicorp/terraform-plugin-log/tflog"
+	turingpi "github.com/jlec/terraform-provider-turing-pi-bmc/internal/api"
+)
+
+// Ensure provider defined types fully satisfy framework interfaces.
+// Ensure the implementation satisfies the expected interfaces.
+var (
+	_ datasource.DataSource              = &powerDataSource{}
+	_ datasource.DataSourceWithConfigure = &powerDataSource{}
+)
+
+// NewPowerDataSource is a helper function to simplify the provider implementation.
+func NewPowerDataSource() datasource.DataSource {
+	return &powerDataSource{}
+}
+
+// powerDataSource defines the data source implementation.
+type powerDataSource struct {
+	client *turingpi.Client
+}
+
+// powerDataSourceModel describes the data source data model.
+type powerDataSourceModel struct {
+	ID    types.String `tfsdk:"id"`
+	Node1 types.Int64  `tfsdk:"node1"`
+	Node2 types.Int64  `tfsdk:"node2"`
+	Node3 types.Int64  `tfsdk:"node3"`
+	Node4 types.Int64  `tfsdk:"node4"`
+}
+
+func (d *powerDataSource) Metadata(ctx context.Context, req datasource.MetadataRequest, resp *datasource.MetadataResponse) {
+	resp.TypeName = req.ProviderTypeName + "_power"
+}
+
+func (d *powerDataSource) Schema(ctx context.Context, req datasource.SchemaRequest, resp *datasource.SchemaResponse) {
+	resp.Schema = schema.Schema{
+		// This description is used by the documentation generator and the language server.
+		MarkdownDescription: "Turing PI Power Data Source",
+
+		Attributes: map[string]schema.Attribute{
+			"id": schema.StringAttribute{
+				Description: "ID",
+				Computed:    true,
+			},
+			"node1": schema.Int64Attribute{
+				MarkdownDescription: "Power state of Node 1",
+				Computed:            true,
+			},
+			"node2": schema.Int64Attribute{
+				MarkdownDescription: "Power state of Node 2",
+				Computed:            true,
+			},
+			"node3": schema.Int64Attribute{
+				MarkdownDescription: "Power state of Node 3",
+				Computed:            true,
+			},
+			"node4": schema.Int64Attribute{
+				MarkdownDescription: "Power state of Node 4",
+				Computed:            true,
+			},
+		},
+	}
+}
+
+// FIXME: RO attribute.
+func (d *powerDataSource) Configure(
+	ctx context.Context,
+	req datasource.ConfigureRequest,
+	resp *datasource.ConfigureResponse,
+) {
+	var ok bool
+	// Prevent panic if the provider has not been configured.
+	if req.ProviderData == nil {
+		return
+	}
+
+	d.client, ok = req.ProviderData.(*turingpi.Client)
+	if !ok {
+		resp.Diagnostics.AddError("Client Error", "failed to get client")
+	}
+}
+
+func (d *powerDataSource) Read(ctx context.Context, req datasource.ReadRequest, resp *datasource.ReadResponse) {
+	var data powerDataSourceModel
+
+	// Read Terraform configuration data into the model
+	resp.Diagnostics.Append(req.Config.Get(ctx, &data)...)
+
+	if resp.Diagnostics.HasError() {
+		return
+	}
+
+	// If applicable, this is a great opportunity to initialize any necessary
+	// provider client data and make a call using it.
+	power, err := d.client.GetPower()
+	if err != nil {
+		resp.Diagnostics.AddError("Client Error", fmt.Sprintf("Unable to read power data, got error: %s", err))
+
+		return
+	}
+
+	// For the purposes of this example code, hardcoding a response value to
+	// save into the Terraform state.
+	data.ID = types.StringValue("power")
+	data.Node1 = types.Int64Value(power.Node1)
+	data.Node2 = types.Int64Value(power.Node2)
+	data.Node3 = types.Int64Value(power.Node3)
+	data.Node4 = types.Int64Value(power.Node4)
+
+	// Write logs using the tflog package
+	// Documentation: https://terraform.io/plugin/log
+	tflog.Trace(ctx, "read a data source")
+
+	// Save data into Terraform state
+	resp.Diagnostics.Append(resp.State.Set(ctx, &data)...)
+}
diff --git a/internal/provider/power_data_source_test.go b/internal/provider/power_data_source_test.go
@@ -0,0 +1,28 @@
+package provider_test
+
+import (
+	"testing"
+
+	"github.com/hashicorp/terraform-plugin-testing/helper/resource"
+)
+
+const testAccPowerDataSourceConfig = `
+data "turing-pi-bmc_power" "test" {
+}
+`
+
+func TestAccPowerDataSource(t *testing.T) {
+	resource.Test(t, resource.TestCase{
+		PreCheck:                 func() { testAccPreCheck(t) },
+		ProtoV6ProviderFactories: testAccProtoV6ProviderFactories,
+		Steps: []resource.TestStep{
+			// Read testing
+			{
+				Config: providerConfig + testAccPowerDataSourceConfig,
+				Check: resource.ComposeAggregateTestCheckFunc(
+					resource.TestCheckResourceAttr("data.turing-pi-bmc_power.test", "node1", "0"),
+				),
+			},
+		},
+	})
+}
diff --git a/internal/provider/provider.go b/internal/provider/provider.go
diff --git a/internal/provider/sdcard_data_source.go b/internal/provider/sdcard_data_source.go
diff --git a/internal/provider/usb_data_source.go b/internal/provider/usb_data_source.go
diff --git a/internal/provider/usb_data_source_test.go b/internal/provider/usb_data_source_test.go
