feat: add nodeinfo data source

Author: jlec

examples/data-sources/nodeinfo/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_nodeinfo" "example" {
+}
+
+output "nodeinfo" {
+  value = data.turing-pi-bmc_nodeinfo.example
+}

internal/api/model.go

@@ -9,3 +9,14 @@ type SDCard struct {
 type SDCardResponse struct {
 	Response []SDCard `json:"response"`
 }
+
+type NodeInfo struct {
+	Node1 string `json:"node1"`
+	Node2 string `json:"node2"`
+	Node3 string `json:"node3"`
+	Node4 string `json:"node4"`
+}
+
+type NodeInfoResponse struct {
+	Response []NodeInfo `json:"response"`
+}

internal/api/nodeinfo.go

@@ -0,0 +1,29 @@
+package turingpi
+
+import (
+	"encoding/json"
+	"fmt"
+	"net/http"
+)
+
+// GetNodeInfo - Returns Turing Pi BMC SD card status.
+func (c *Client) GetNodeInfo() (NodeInfo, error) {
+	req, err := http.NewRequest(http.MethodGet, fmt.Sprintf("%s?opt=get&type=nodeinfo", c.ApiURI), nil)
+	if err != nil {
+		return NodeInfo{}, err
+	}
+
+	body, err := c.doRequest(req)
+	if err != nil {
+		return NodeInfo{}, err
+	}
+
+	sdCardResponse := NodeInfoResponse{}
+	err = json.Unmarshal(body, &sdCardResponse)
+
+	if err != nil {
+		return NodeInfo{}, err
+	}
+
+	return sdCardResponse.Response[0], nil
+}

internal/provider/nodeinfo_data_source.go

@@ -0,0 +1,129 @@
+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              = &nodeInfoDataSource{}
+	_ 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{}
+}
+
+// nodeInfoDataSource defines the data source implementation.
+type nodeInfoDataSource struct {
+	client *turingpi.Client
+}
+
+// nodeInfoDataSourceModel describes the data source data model.
+type nodeInfoDataSourceModel struct {
+	ID    types.String `tfsdk:"id"`
+	Node1 types.String `tfsdk:"node1"`
+	Node2 types.String `tfsdk:"node2"`
+	Node3 types.String `tfsdk:"node3"`
+	Node4 types.String `tfsdk:"node4"`
+}
+
+func (d *nodeInfoDataSource) Metadata(ctx context.Context, req datasource.MetadataRequest, resp *datasource.MetadataResponse) {
+	resp.TypeName = req.ProviderTypeName + "_nodeinfo"
+}
+
+func (d *nodeInfoDataSource) 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 NodeInfo Data Source",
+
+		Attributes: map[string]schema.Attribute{
+			"id": schema.StringAttribute{
+				Description: "ID",
+				Computed:    true,
+			},
+			"node1": schema.StringAttribute{
+				MarkdownDescription: "Information for Node 1",
+				Computed:            true,
+			},
+			"node2": schema.StringAttribute{
+				MarkdownDescription: "Information for Node 2",
+				Computed:            true,
+			},
+			"node3": schema.StringAttribute{
+				MarkdownDescription: "Information for Node 3",
+				Computed:            true,
+			},
+			"node4": schema.StringAttribute{
+				MarkdownDescription: "Information for Node 4",
+				Computed:            true,
+			},
+		},
+	}
+}
+
+// FIXME: RO attribute.
+func (d *nodeInfoDataSource) 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 *nodeInfoDataSource) Read(ctx context.Context, req datasource.ReadRequest, resp *datasource.ReadResponse) {
+	var data nodeInfoDataSourceModel
+
+	// 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.
+	nodeInfo, err := d.client.GetNodeInfo()
+	if err != nil {
+		resp.Diagnostics.AddError("Client Error", fmt.Sprintf("Unable to read nodeinfo 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("nodeinfo")
+	data.Node1 = types.StringValue(nodeInfo.Node1)
+	data.Node2 = types.StringValue(nodeInfo.Node2)
+	data.Node3 = types.StringValue(nodeInfo.Node3)
+	data.Node4 = types.StringValue(nodeInfo.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)...)
+}

internal/provider/nodeinfo_data_source_test.go

@@ -0,0 +1,28 @@
+package provider_test
+
+import (
+	"testing"
+
+	"github.com/hashicorp/terraform-plugin-testing/helper/resource"
+)
+
+const testAccNodeInfoDataSourceConfig = `
+data "turing-pi-bmc_nodeinfo" "test" {
+}
+`
+
+func TestAccNodeInfoDataSource(t *testing.T) {
+	resource.Test(t, resource.TestCase{
+		PreCheck:                 func() { testAccPreCheck(t) },
+		ProtoV6ProviderFactories: testAccProtoV6ProviderFactories,
+		Steps: []resource.TestStep{
+			// Read testing
+			{
+				Config: providerConfig + testAccNodeInfoDataSourceConfig,
+				Check: resource.ComposeAggregateTestCheckFunc(
+					resource.TestCheckResourceAttr("data.turing-pi-bmc_nodeinfo.test", "node1", "unknown"),
+				),
+			},
+		},
+	})
+}

internal/provider/provider.go

@@ -84,6 +84,7 @@ func (p *TuringPiBMCProvider) Resources(ctx context.Context) []func() resource.R
 func (p *TuringPiBMCProvider) DataSources(ctx context.Context) []func() datasource.DataSource {
 	return []func() datasource.DataSource{
 		NewSDCardDataSource,
+		NewNodeInfoDataSource,
 	}
 }
 

internal/provider/sdcard_data_source_test.go

@@ -6,19 +6,19 @@ import (
 	"github.com/hashicorp/terraform-plugin-testing/helper/resource"
 )
 
-const testAccSdCardDataSourceConfig = `
+const testAccSDCardDataSourceConfig = `
 data "turing-pi-bmc_sdcard" "test" {
 }
 `
 
-func TestAccSdCardDataSource(t *testing.T) {
+func TestAccSDCardDataSource(t *testing.T) {
 	resource.Test(t, resource.TestCase{
 		PreCheck:                 func() { testAccPreCheck(t) },
 		ProtoV6ProviderFactories: testAccProtoV6ProviderFactories,
 		Steps: []resource.TestStep{
 			// Read testing
 			{
-				Config: providerConfig + testAccSdCardDataSourceConfig,
+				Config: providerConfig + testAccSDCardDataSourceConfig,
 				Check: resource.ComposeAggregateTestCheckFunc(
 					resource.TestCheckResourceAttr("data.turing-pi-bmc_sdcard.test", "total", "0"),
 				),