Add artifactapi_local_goproxy resource #28
@@ -0,0 +1,13 @@
|
||||
# `artifactapi_local_goproxy`
|
||||
|
||||
Local resources manage repositories that ArtifactAPI hosts directly (rather than
|
||||
proxying an upstream) — each is a real registry for its package type.
|
||||
|
||||
A Go module proxy for private modules (GOPROXY protocol: `go get`, `go mod download`).
|
||||
|
||||
Each takes just `name` (required, forces replacement) and an optional
|
||||
`description`.
|
||||
|
||||
## Example
|
||||
|
||||
See `examples/resources/artifactapi_local_goproxy/main.tf`.
|
||||
@@ -0,0 +1,4 @@
|
||||
resource "artifactapi_local_goproxy" "internal" {
|
||||
name = "go-internal"
|
||||
description = "Internal Go module proxy"
|
||||
}
|
||||
@@ -0,0 +1,166 @@
|
||||
package provider
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
|
||||
"github.com/hashicorp/terraform-plugin-framework/path"
|
||||
"github.com/hashicorp/terraform-plugin-framework/resource"
|
||||
"github.com/hashicorp/terraform-plugin-framework/resource/schema"
|
||||
"github.com/hashicorp/terraform-plugin-framework/resource/schema/planmodifier"
|
||||
"github.com/hashicorp/terraform-plugin-framework/resource/schema/stringdefault"
|
||||
"github.com/hashicorp/terraform-plugin-framework/resource/schema/stringplanmodifier"
|
||||
"github.com/hashicorp/terraform-plugin-framework/types"
|
||||
)
|
||||
|
||||
var (
|
||||
_ resource.Resource = &localGoProxyResource{}
|
||||
_ resource.ResourceWithImportState = &localGoProxyResource{}
|
||||
)
|
||||
|
||||
type localGoProxyResource struct {
|
||||
client *apiClient
|
||||
}
|
||||
|
||||
type localGoProxyResourceModel struct {
|
||||
Name types.String `tfsdk:"name"`
|
||||
Description types.String `tfsdk:"description"`
|
||||
}
|
||||
|
||||
func init() { registerResource(NewLocalGoProxyResource) }
|
||||
|
||||
func NewLocalGoProxyResource() resource.Resource {
|
||||
return &localGoProxyResource{}
|
||||
}
|
||||
|
||||
func (r *localGoProxyResource) Metadata(_ context.Context, req resource.MetadataRequest, resp *resource.MetadataResponse) {
|
||||
resp.TypeName = req.ProviderTypeName + "_local_goproxy"
|
||||
}
|
||||
|
||||
func (r *localGoProxyResource) Schema(_ context.Context, _ resource.SchemaRequest, resp *resource.SchemaResponse) {
|
||||
resp.Schema = schema.Schema{
|
||||
Description: "Manages a local ArtifactAPI Go module proxy for hosting private Go modules directly.",
|
||||
Attributes: map[string]schema.Attribute{
|
||||
"name": schema.StringAttribute{
|
||||
Description: "Unique name of the local Go module proxy.",
|
||||
Required: true,
|
||||
PlanModifiers: []planmodifier.String{
|
||||
stringplanmodifier.RequiresReplace(),
|
||||
},
|
||||
},
|
||||
"description": schema.StringAttribute{
|
||||
Description: "Human-readable description.",
|
||||
Optional: true,
|
||||
Computed: true,
|
||||
Default: stringdefault.StaticString(""),
|
||||
},
|
||||
},
|
||||
}
|
||||
}
|
||||
|
||||
func (r *localGoProxyResource) Configure(_ context.Context, req resource.ConfigureRequest, resp *resource.ConfigureResponse) {
|
||||
if req.ProviderData == nil {
|
||||
return
|
||||
}
|
||||
client, ok := req.ProviderData.(*apiClient)
|
||||
if !ok {
|
||||
resp.Diagnostics.AddError("unexpected provider data type", fmt.Sprintf("got %T", req.ProviderData))
|
||||
return
|
||||
}
|
||||
r.client = client
|
||||
}
|
||||
|
||||
func (r *localGoProxyResource) Create(ctx context.Context, req resource.CreateRequest, resp *resource.CreateResponse) {
|
||||
var plan localGoProxyResourceModel
|
||||
resp.Diagnostics.Append(req.Plan.Get(ctx, &plan)...)
|
||||
if resp.Diagnostics.HasError() {
|
||||
return
|
||||
}
|
||||
|
||||
api := localGoProxyModelToAPI(plan)
|
||||
api.ManagedBy = "terraform"
|
||||
|
||||
var created remoteAPI
|
||||
if err := r.client.post(ctx, "/api/v2/remotes", api, &created); err != nil {
|
||||
resp.Diagnostics.AddError("create local goproxy failed", err.Error())
|
||||
return
|
||||
}
|
||||
|
||||
state := localGoProxyAPIToModel(created)
|
||||
resp.Diagnostics.Append(resp.State.Set(ctx, state)...)
|
||||
}
|
||||
|
||||
func (r *localGoProxyResource) Read(ctx context.Context, req resource.ReadRequest, resp *resource.ReadResponse) {
|
||||
var state localGoProxyResourceModel
|
||||
resp.Diagnostics.Append(req.State.Get(ctx, &state)...)
|
||||
if resp.Diagnostics.HasError() {
|
||||
return
|
||||
}
|
||||
|
||||
var remote remoteAPI
|
||||
err := r.client.get(ctx, "/api/v2/remotes/"+state.Name.ValueString(), &remote)
|
||||
if err != nil {
|
||||
if isNotFound(err) {
|
||||
resp.State.RemoveResource(ctx)
|
||||
return
|
||||
}
|
||||
resp.Diagnostics.AddError("read local goproxy failed", err.Error())
|
||||
return
|
||||
}
|
||||
|
||||
newState := localGoProxyAPIToModel(remote)
|
||||
resp.Diagnostics.Append(resp.State.Set(ctx, newState)...)
|
||||
}
|
||||
|
||||
func (r *localGoProxyResource) Update(ctx context.Context, req resource.UpdateRequest, resp *resource.UpdateResponse) {
|
||||
var plan localGoProxyResourceModel
|
||||
resp.Diagnostics.Append(req.Plan.Get(ctx, &plan)...)
|
||||
if resp.Diagnostics.HasError() {
|
||||
return
|
||||
}
|
||||
|
||||
api := localGoProxyModelToAPI(plan)
|
||||
api.ManagedBy = "terraform"
|
||||
|
||||
var updated remoteAPI
|
||||
if err := r.client.put(ctx, "/api/v2/remotes/"+plan.Name.ValueString(), api, &updated); err != nil {
|
||||
resp.Diagnostics.AddError("update local goproxy failed", err.Error())
|
||||
return
|
||||
}
|
||||
|
||||
state := localGoProxyAPIToModel(updated)
|
||||
resp.Diagnostics.Append(resp.State.Set(ctx, state)...)
|
||||
}
|
||||
|
||||
func (r *localGoProxyResource) Delete(ctx context.Context, req resource.DeleteRequest, resp *resource.DeleteResponse) {
|
||||
var state localGoProxyResourceModel
|
||||
resp.Diagnostics.Append(req.State.Get(ctx, &state)...)
|
||||
if resp.Diagnostics.HasError() {
|
||||
return
|
||||
}
|
||||
|
||||
if err := r.client.del(ctx, "/api/v2/remotes/"+state.Name.ValueString()); err != nil {
|
||||
resp.Diagnostics.AddError("delete local goproxy failed", err.Error())
|
||||
return
|
||||
}
|
||||
}
|
||||
|
||||
func (r *localGoProxyResource) ImportState(ctx context.Context, req resource.ImportStateRequest, resp *resource.ImportStateResponse) {
|
||||
resource.ImportStatePassthroughID(ctx, path.Root("name"), req, resp)
|
||||
}
|
||||
|
||||
func localGoProxyModelToAPI(m localGoProxyResourceModel) remoteAPI {
|
||||
return remoteAPI{
|
||||
Name: m.Name.ValueString(),
|
||||
PackageType: "goproxy",
|
||||
RepoType: "local",
|
||||
Description: m.Description.ValueString(),
|
||||
}
|
||||
}
|
||||
|
||||
func localGoProxyAPIToModel(api remoteAPI) localGoProxyResourceModel {
|
||||
return localGoProxyResourceModel{
|
||||
Name: types.StringValue(api.Name),
|
||||
Description: types.StringValue(api.Description),
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,125 @@
|
||||
package provider
|
||||
|
||||
import (
|
||||
"context"
|
||||
"testing"
|
||||
|
||||
"github.com/hashicorp/terraform-plugin-framework/resource"
|
||||
"github.com/hashicorp/terraform-plugin-framework/types"
|
||||
)
|
||||
|
||||
func TestLocalGoProxyModelToAPI(t *testing.T) {
|
||||
model := localGoProxyResourceModel{
|
||||
Name: types.StringValue("go-internal"),
|
||||
Description: types.StringValue("Internal Go modules"),
|
||||
}
|
||||
|
||||
api := localGoProxyModelToAPI(model)
|
||||
|
||||
if api.Name != "go-internal" {
|
||||
t.Errorf("Name: expected go-internal, got %s", api.Name)
|
||||
}
|
||||
if api.PackageType != "goproxy" {
|
||||
t.Errorf("PackageType: expected goproxy, got %s", api.PackageType)
|
||||
}
|
||||
if api.RepoType != "local" {
|
||||
t.Errorf("RepoType: expected local, got %s", api.RepoType)
|
||||
}
|
||||
if api.Description != "Internal Go modules" {
|
||||
t.Errorf("Description: expected 'Internal Go modules', got %s", api.Description)
|
||||
}
|
||||
}
|
||||
|
||||
func TestLocalGoProxyModelToAPI_EmptyDescription(t *testing.T) {
|
||||
model := localGoProxyResourceModel{
|
||||
Name: types.StringValue("go-empty"),
|
||||
Description: types.StringValue(""),
|
||||
}
|
||||
|
||||
api := localGoProxyModelToAPI(model)
|
||||
|
||||
if api.Name != "go-empty" {
|
||||
t.Errorf("Name: expected go-empty, got %s", api.Name)
|
||||
}
|
||||
if api.Description != "" {
|
||||
t.Errorf("Description: expected empty string, got %s", api.Description)
|
||||
}
|
||||
if api.PackageType != "goproxy" {
|
||||
t.Errorf("PackageType: expected goproxy, got %s", api.PackageType)
|
||||
}
|
||||
if api.RepoType != "local" {
|
||||
t.Errorf("RepoType: expected local, got %s", api.RepoType)
|
||||
}
|
||||
}
|
||||
|
||||
func TestLocalGoProxyAPIToModel(t *testing.T) {
|
||||
api := remoteAPI{
|
||||
Name: "go-internal",
|
||||
PackageType: "goproxy",
|
||||
RepoType: "local",
|
||||
Description: "Internal Go modules",
|
||||
ManagedBy: "terraform",
|
||||
}
|
||||
|
||||
model := localGoProxyAPIToModel(api)
|
||||
|
||||
if model.Name.ValueString() != "go-internal" {
|
||||
t.Errorf("Name: expected go-internal, got %s", model.Name.ValueString())
|
||||
}
|
||||
if model.Description.ValueString() != "Internal Go modules" {
|
||||
t.Errorf("Description: expected 'Internal Go modules', got %s", model.Description.ValueString())
|
||||
}
|
||||
}
|
||||
|
||||
func TestLocalGoProxyRoundTrip(t *testing.T) {
|
||||
original := localGoProxyResourceModel{
|
||||
Name: types.StringValue("roundtrip-go"),
|
||||
Description: types.StringValue("Round trip test"),
|
||||
}
|
||||
|
||||
api := localGoProxyModelToAPI(original)
|
||||
result := localGoProxyAPIToModel(api)
|
||||
|
||||
if result.Name.ValueString() != original.Name.ValueString() {
|
||||
t.Errorf("Name: expected %s, got %s", original.Name.ValueString(), result.Name.ValueString())
|
||||
}
|
||||
if result.Description.ValueString() != original.Description.ValueString() {
|
||||
t.Errorf("Description: expected %s, got %s", original.Description.ValueString(), result.Description.ValueString())
|
||||
}
|
||||
}
|
||||
|
||||
func TestLocalGoProxyResource_Metadata(t *testing.T) {
|
||||
r := NewLocalGoProxyResource()
|
||||
req := resource.MetadataRequest{ProviderTypeName: "artifactapi"}
|
||||
var resp resource.MetadataResponse
|
||||
r.Metadata(context.Background(), req, &resp)
|
||||
if resp.TypeName != "artifactapi_local_goproxy" {
|
||||
t.Errorf("expected artifactapi_local_goproxy, got %s", resp.TypeName)
|
||||
}
|
||||
}
|
||||
|
||||
func TestLocalGoProxyResource_Schema(t *testing.T) {
|
||||
r := NewLocalGoProxyResource()
|
||||
req := resource.SchemaRequest{}
|
||||
var resp resource.SchemaResponse
|
||||
r.Schema(context.Background(), req, &resp)
|
||||
|
||||
expectedAttrs := []string{"name", "description"}
|
||||
for _, attr := range expectedAttrs {
|
||||
if _, ok := resp.Schema.Attributes[attr]; !ok {
|
||||
t.Errorf("missing expected attribute: %s", attr)
|
||||
}
|
||||
}
|
||||
|
||||
if len(resp.Schema.Attributes) != len(expectedAttrs) {
|
||||
t.Errorf("expected %d attributes, got %d", len(expectedAttrs), len(resp.Schema.Attributes))
|
||||
}
|
||||
}
|
||||
|
||||
func TestNewLocalGoProxyResource_Type(t *testing.T) {
|
||||
r := NewLocalGoProxyResource()
|
||||
_, ok := r.(*localGoProxyResource)
|
||||
if !ok {
|
||||
t.Error("expected *localGoProxyResource")
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user