feat: Add resource for USB interface

jlec · jlec · commit 832f49f4bb57 · 2023-04-23T16:57:54.000+01:00
diff --git a/.gitignore b/.gitignore
@@ -343,3 +343,4 @@ nomad/nomad.rc
 #
 ###############################################################################
 terraform-provider-turing-pi-bmc
+examples/**/.terraform.lock.hcl
diff --git a/docs/index.md b/docs/index.md
@@ -25,7 +25,7 @@ terraform {
 }
 
 provider "turing-pi-bmc" {
-  endpoint = "10.100.100.231"
+  endpoint = "turingpi"
 }
 ```
 
diff --git a/docs/resources/usb.md b/docs/resources/usb.md
@@ -0,0 +1,25 @@
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "turing-pi-bmc_usb Resource - terraform-provider-turing-pi-bmc"
+subcategory: ""
+description: |-
+  Turing PI Usb Resource
+---
+
+# turing-pi-bmc_usb (Resource)
+
+Turing PI Usb Resource
+
+
+
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Required
+
+- `mode` (Number) USB mode
+- `node` (Number) Node using USB
+
+### Read-Only
+
+- `id` (String) Identifier
diff --git a/examples/data-sources/nodeinfo/data-source.tf b/examples/data-sources/nodeinfo/data-source.tf
@@ -11,7 +11,7 @@ terraform {
 }
 
 provider "turing-pi-bmc" {
-  endpoint = "10.100.100.231"
+  endpoint = "turingpi"
 }
 
 data "turing-pi-bmc_nodeinfo" "example" {
diff --git a/examples/data-sources/power/data-source.tf b/examples/data-sources/power/data-source.tf
@@ -11,7 +11,7 @@ terraform {
 }
 
 provider "turing-pi-bmc" {
-  endpoint = "10.100.100.231"
+  endpoint = "turingpi"
 }
 
 data "turing-pi-bmc_power" "example" {
diff --git a/examples/data-sources/sdcard/data-source.tf b/examples/data-sources/sdcard/data-source.tf
@@ -11,7 +11,7 @@ terraform {
 }
 
 provider "turing-pi-bmc" {
-  endpoint = "10.100.100.231"
+  endpoint = "turingpi"
 }
 
 data "turing-pi-bmc_sdcard" "example" {
diff --git a/examples/data-sources/usb/data-source.tf b/examples/data-sources/usb/data-source.tf
@@ -11,7 +11,7 @@ terraform {
 }
 
 provider "turing-pi-bmc" {
-  endpoint = "10.100.100.231"
+  endpoint = "turingpi"
 }
 
 data "turing-pi-bmc_usb" "example" {
diff --git a/examples/provider/provider.tf b/examples/provider/provider.tf
@@ -10,5 +10,5 @@ terraform {
 }
 
 provider "turing-pi-bmc" {
-  endpoint = "10.100.100.231"
+  endpoint = "turingpi"
 }
diff --git a/examples/resources/usb/resource.tf b/examples/resources/usb/resource.tf
@@ -0,0 +1,17 @@
+terraform {
+  required_providers {
+    turing-pi-bmc = {
+      source  = "jlec.de/dev/turing-pi-bmc"
+      version = ">0"
+    }
+  }
+}
+
+provider "turing-pi-bmc" {
+  endpoint = "turingpi"
+}
+
+resource "turing-pi-bmc_usb" "example" {
+  node = 4
+  mode = 0
+}
diff --git a/go.mod b/go.mod
@@ -29,6 +29,7 @@ require (
 	github.com/hashicorp/logutils v1.0.0 // indirect
 	github.com/hashicorp/terraform-exec v0.18.1 // indirect
 	github.com/hashicorp/terraform-json v0.16.0 // indirect
+	github.com/hashicorp/terraform-plugin-framework-validators v0.10.0
 	github.com/hashicorp/terraform-plugin-sdk/v2 v2.26.1 // indirect
 	github.com/hashicorp/terraform-registry-address v0.2.0 // indirect
 	github.com/hashicorp/terraform-svchost v0.1.0 // indirect
diff --git a/go.sum b/go.sum
@@ -84,6 +84,8 @@ github.com/hashicorp/terraform-json v0.16.0 h1:UKkeWRWb23do5LNAFlh/K3N0ymn1qTOO8
 github.com/hashicorp/terraform-json v0.16.0/go.mod h1:v0Ufk9jJnk6tcIZvScHvetlKfiNTC+WS21mnXIlc0B0=
 github.com/hashicorp/terraform-plugin-framework v1.2.0 h1:MZjFFfULnFq8fh04FqrKPcJ/nGpHOvX4buIygT3MSNY=
 github.com/hashicorp/terraform-plugin-framework v1.2.0/go.mod h1:nToI62JylqXDq84weLJ/U3umUsBhZAaTmU0HXIVUOcw=
+github.com/hashicorp/terraform-plugin-framework-validators v0.10.0 h1:4L0tmy/8esP6OcvocVymw52lY0HyQ5OxB7VNl7k4bS0=
+github.com/hashicorp/terraform-plugin-framework-validators v0.10.0/go.mod h1:qdQJCdimB9JeX2YwOpItEu+IrfoJjWQ5PhLpAOMDQAE=
 github.com/hashicorp/terraform-plugin-go v0.15.0 h1:1BJNSUFs09DS8h/XNyJNJaeusQuWc/T9V99ylU9Zwp0=
 github.com/hashicorp/terraform-plugin-go v0.15.0/go.mod h1:tk9E3/Zx4RlF/9FdGAhwxHExqIHHldqiQGt20G6g+nQ=
 github.com/hashicorp/terraform-plugin-log v0.8.0 h1:pX2VQ/TGKu+UU1rCay0OlzosNKe4Nz1pepLXj95oyy0=
diff --git a/internal/api/client.go b/internal/api/client.go
@@ -43,3 +43,31 @@ func (c *Client) doRequest(req *http.Request) ([]byte, error) {
 
 	return body, err
 }
+
+func (c *Client) Get(params string) ([]byte, error) {
+	req, err := http.NewRequest(http.MethodGet, fmt.Sprintf("%s?%s", c.ApiURI, params), nil)
+	if err != nil {
+		return nil, err
+	}
+
+	body, err := c.doRequest(req)
+	if err != nil {
+		return nil, err
+	}
+
+	return body, nil
+}
+
+func (c *Client) Set(params string) ([]byte, error) {
+	req, err := http.NewRequest(http.MethodPost, fmt.Sprintf("%s?%s", c.ApiURI, params), nil)
+	if err != nil {
+		return nil, err
+	}
+
+	body, err := c.doRequest(req)
+	if err != nil {
+		return nil, err
+	}
+
+	return body, nil
+}
diff --git a/internal/api/error.go b/internal/api/error.go
@@ -0,0 +1,9 @@
+package turingpi
+
+type ResultError struct {
+	Reason string
+}
+
+func (m *ResultError) Error() string {
+	return m.Reason
+}
diff --git a/internal/api/model.go b/internal/api/model.go
@@ -40,3 +40,11 @@ type Usb struct {
 type UsbResponse struct {
 	Response []Usb `json:"response"`
 }
+
+type Result struct {
+	Result string `json:"result"`
+}
+
+type ResultResponse struct {
+	Response []Result `json:"response"`
+}
diff --git a/internal/api/usb.go b/internal/api/usb.go
@@ -3,27 +3,42 @@ 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)
+	response := UsbResponse{}
+
+	body, err := c.Get("opt=get&type=usb")
 	if err != nil {
 		return Usb{}, err
 	}
 
-	body, err := c.doRequest(req)
+	err = json.Unmarshal(body, &response)
 	if err != nil {
 		return Usb{}, err
 	}
 
-	sdCardResponse := UsbResponse{}
-	err = json.Unmarshal(body, &sdCardResponse)
+	return response.Response[0], nil
+}
+
+// SetUsb - Returns Turing Pi BMC SD card status.
+func (c *Client) SetUsb(mode, node int64) (Result, error) {
+	response := ResultResponse{}
 
+	body, err := c.Set(fmt.Sprintf("opt=set&type=usb&mode=%d&node=%d", mode, node))
 	if err != nil {
-		return Usb{}, err
+		return Result{}, err
+	}
+
+	err = json.Unmarshal(body, &response)
+	if err != nil {
+		return Result{}, err
+	}
+
+	if response.Response[0].Result != "ok" {
+		return response.Response[0], &ResultError{Reason: response.Response[0].Result}
 	}
 
-	return sdCardResponse.Response[0], nil
+	return response.Response[0], nil
 }
diff --git a/internal/provider/all_test.go b/internal/provider/all_test.go
@@ -14,7 +14,7 @@ terraform {
 	}
 }
 provider "turing-pi-bmc" {
-	endpoint = "10.100.100.231"
+	endpoint = "turingpi"
 }
 `
 )
diff --git a/internal/provider/constants.go b/internal/provider/constants.go
@@ -0,0 +1,3 @@
+package provider
+
+const NodeCount int64 = 4
diff --git a/internal/provider/provider.go b/internal/provider/provider.go
@@ -78,6 +78,7 @@ func (p *TuringPiBMCProvider) Configure(ctx context.Context, req provider.Config
 func (p *TuringPiBMCProvider) Resources(ctx context.Context) []func() resource.Resource {
 	return []func() resource.Resource{
 		// NewSDCardDataSource,
+		NewUsbResource,
 	}
 }
 
diff --git a/internal/provider/usb_resource.go b/internal/provider/usb_resource.go
diff --git a/internal/provider/usb_resource_test.go b/internal/provider/usb_resource_test.go

Original file line number	Diff line number	Diff line change
`@@ -343,3 +343,4 @@ nomad/nomad.rc`
`343`	`343`	`#`
`344`	`344`	`###############################################################################`
`345`	`345`	`terraform-provider-turing-pi-bmc`
	`346`	`+examples/**/.terraform.lock.hcl`
Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,7 @@ terraform {`
`25`	`25`	`}`
`26`	`26`
`27`	`27`	`provider "turing-pi-bmc" {`
`28`		`- endpoint = "10.100.100.231"`
	`28`	`+ endpoint = "turingpi"`
`29`	`29`	`}`
`30`	`30`	```
`31`	`31`
Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@ terraform {`
`11`	`11`	`}`
`12`	`12`
`13`	`13`	`provider "turing-pi-bmc" {`
`14`		`- endpoint = "10.100.100.231"`
	`14`	`+ endpoint = "turingpi"`
`15`	`15`	`}`
`16`	`16`
`17`	`17`	`data "turing-pi-bmc_nodeinfo" "example" {`
Original file line number	Diff line number	Diff line change
`@@ -10,5 +10,5 @@ terraform {`
`10`	`10`	`}`
`11`	`11`
`12`	`12`	`provider "turing-pi-bmc" {`
`13`		`- endpoint = "10.100.100.231"`
	`13`	`+ endpoint = "turingpi"`
`14`	`14`	`}`