diff --git a/README.md b/README.md index c36b21c..aa95639 100644 --- a/README.md +++ b/README.md @@ -58,6 +58,7 @@ Available resource types: - `artifactapi_remote_pypi` - `artifactapi_remote_npm` - `artifactapi_remote_rpm` +- `artifactapi_remote_deb` - `artifactapi_remote_alpine` - `artifactapi_remote_puppet` - `artifactapi_remote_terraform` @@ -139,6 +140,7 @@ Available resource types: - `artifactapi_local_docker` — a container registry (Docker Registry HTTP API V2, push and pull) - `artifactapi_local_pypi` - `artifactapi_local_rpm` +- `artifactapi_local_deb` - `artifactapi_local_terraform` Each takes just `name` (required, forces replacement) and an optional diff --git a/examples/resources/artifactapi_local_deb/main.tf b/examples/resources/artifactapi_local_deb/main.tf new file mode 100644 index 0000000..7bfe3ef --- /dev/null +++ b/examples/resources/artifactapi_local_deb/main.tf @@ -0,0 +1,4 @@ +resource "artifactapi_local_deb" "internal" { + name = "deb-internal" + description = "Internal Deb package repository" +} diff --git a/examples/resources/artifactapi_remote_deb/main.tf b/examples/resources/artifactapi_remote_deb/main.tf new file mode 100644 index 0000000..f7a339b --- /dev/null +++ b/examples/resources/artifactapi_remote_deb/main.tf @@ -0,0 +1,23 @@ +terraform { + required_providers { + artifactapi = { + source = "git.unkin.net/unkin/artifactapi" + version = "0.0.1" + } + } +} + +provider "artifactapi" { + endpoint = "https://artifactapi.example.com" +} + +# Deb remote proxies a Debian/apt package repository. +# The provider knows the index files (Release, Packages) are mutable; .deb packages are immutable. +resource "artifactapi_remote_deb" "debian" { + name = "debian" + base_url = "http://deb.debian.org/debian" + description = "Debian apt package repository" + + immutable_ttl = 0 + mutable_ttl = 7200 +} diff --git a/internal/provider/provider.go b/internal/provider/provider.go index 9fdcd98..545bb05 100644 --- a/internal/provider/provider.go +++ b/internal/provider/provider.go @@ -63,6 +63,7 @@ func (p *ArtifactAPIProvider) Resources(_ context.Context) []func() resource.Res newRemoteResource("pypi"), newRemoteResource("npm"), newRemoteResource("rpm"), + newRemoteResource("deb"), newRemoteResource("alpine"), newRemoteResource("puppet"), newRemoteResource("terraform"), @@ -72,6 +73,7 @@ func (p *ArtifactAPIProvider) Resources(_ context.Context) []func() resource.Res NewLocalTerraformResource, NewLocalPyPIResource, NewLocalRPMResource, + NewLocalDebResource, NewLocalDockerResource, NewLocalGenericResource, } diff --git a/internal/provider/provider_test.go b/internal/provider/provider_test.go index 102d8a9..d690f3f 100644 --- a/internal/provider/provider_test.go +++ b/internal/provider/provider_test.go @@ -66,8 +66,8 @@ func TestProvider_Resources(t *testing.T) { p := &ArtifactAPIProvider{version: "1.0.0"} resources := p.Resources(context.Background()) - // 11 remote resource types + 1 virtual + local_terraform/pypi/rpm/docker/generic = 17 - expectedCount := 17 + // 12 remote resource types + 1 virtual + local_terraform/pypi/rpm/deb/docker/generic = 19 + expectedCount := 19 if len(resources) != expectedCount { t.Fatalf("expected %d resources, got %d", expectedCount, len(resources)) } @@ -102,6 +102,7 @@ func TestProvider_Resources_ContainsExpectedTypes(t *testing.T) { "artifactapi_remote_pypi", "artifactapi_remote_npm", "artifactapi_remote_rpm", + "artifactapi_remote_deb", "artifactapi_remote_alpine", "artifactapi_remote_puppet", "artifactapi_remote_terraform", @@ -111,6 +112,7 @@ func TestProvider_Resources_ContainsExpectedTypes(t *testing.T) { "artifactapi_local_terraform", "artifactapi_local_pypi", "artifactapi_local_rpm", + "artifactapi_local_deb", "artifactapi_local_docker", "artifactapi_local_generic", } diff --git a/internal/provider/resource_local_deb.go b/internal/provider/resource_local_deb.go new file mode 100644 index 0000000..445d9fb --- /dev/null +++ b/internal/provider/resource_local_deb.go @@ -0,0 +1,164 @@ +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 = &localDebResource{} + _ resource.ResourceWithImportState = &localDebResource{} +) + +type localDebResource struct { + client *apiClient +} + +type localDebResourceModel struct { + Name types.String `tfsdk:"name"` + Description types.String `tfsdk:"description"` +} + +func NewLocalDebResource() resource.Resource { + return &localDebResource{} +} + +func (r *localDebResource) Metadata(_ context.Context, req resource.MetadataRequest, resp *resource.MetadataResponse) { + resp.TypeName = req.ProviderTypeName + "_local_deb" +} + +func (r *localDebResource) Schema(_ context.Context, _ resource.SchemaRequest, resp *resource.SchemaResponse) { + resp.Schema = schema.Schema{ + Description: "Manages a local ArtifactAPI Deb repository for hosting Debian/apt packages directly.", + Attributes: map[string]schema.Attribute{ + "name": schema.StringAttribute{ + Description: "Unique name of the local Deb repository.", + Required: true, + PlanModifiers: []planmodifier.String{ + stringplanmodifier.RequiresReplace(), + }, + }, + "description": schema.StringAttribute{ + Description: "Human-readable description.", + Optional: true, + Computed: true, + Default: stringdefault.StaticString(""), + }, + }, + } +} + +func (r *localDebResource) 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 *localDebResource) Create(ctx context.Context, req resource.CreateRequest, resp *resource.CreateResponse) { + var plan localDebResourceModel + resp.Diagnostics.Append(req.Plan.Get(ctx, &plan)...) + if resp.Diagnostics.HasError() { + return + } + + api := localDebModelToAPI(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 deb failed", err.Error()) + return + } + + state := localDebAPIToModel(created) + resp.Diagnostics.Append(resp.State.Set(ctx, state)...) +} + +func (r *localDebResource) Read(ctx context.Context, req resource.ReadRequest, resp *resource.ReadResponse) { + var state localDebResourceModel + 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 deb failed", err.Error()) + return + } + + newState := localDebAPIToModel(remote) + resp.Diagnostics.Append(resp.State.Set(ctx, newState)...) +} + +func (r *localDebResource) Update(ctx context.Context, req resource.UpdateRequest, resp *resource.UpdateResponse) { + var plan localDebResourceModel + resp.Diagnostics.Append(req.Plan.Get(ctx, &plan)...) + if resp.Diagnostics.HasError() { + return + } + + api := localDebModelToAPI(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 deb failed", err.Error()) + return + } + + state := localDebAPIToModel(updated) + resp.Diagnostics.Append(resp.State.Set(ctx, state)...) +} + +func (r *localDebResource) Delete(ctx context.Context, req resource.DeleteRequest, resp *resource.DeleteResponse) { + var state localDebResourceModel + 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 deb failed", err.Error()) + return + } +} + +func (r *localDebResource) ImportState(ctx context.Context, req resource.ImportStateRequest, resp *resource.ImportStateResponse) { + resource.ImportStatePassthroughID(ctx, path.Root("name"), req, resp) +} + +func localDebModelToAPI(m localDebResourceModel) remoteAPI { + return remoteAPI{ + Name: m.Name.ValueString(), + PackageType: "deb", + RepoType: "local", + Description: m.Description.ValueString(), + } +} + +func localDebAPIToModel(api remoteAPI) localDebResourceModel { + return localDebResourceModel{ + Name: types.StringValue(api.Name), + Description: types.StringValue(api.Description), + } +} diff --git a/internal/provider/resource_local_deb_test.go b/internal/provider/resource_local_deb_test.go new file mode 100644 index 0000000..fd377c1 --- /dev/null +++ b/internal/provider/resource_local_deb_test.go @@ -0,0 +1,125 @@ +package provider + +import ( + "context" + "testing" + + "github.com/hashicorp/terraform-plugin-framework/resource" + "github.com/hashicorp/terraform-plugin-framework/types" +) + +func TestLocalDebModelToAPI(t *testing.T) { + model := localDebResourceModel{ + Name: types.StringValue("deb-internal"), + Description: types.StringValue("Internal Deb repository"), + } + + api := localDebModelToAPI(model) + + if api.Name != "deb-internal" { + t.Errorf("Name: expected deb-internal, got %s", api.Name) + } + if api.PackageType != "deb" { + t.Errorf("PackageType: expected deb, got %s", api.PackageType) + } + if api.RepoType != "local" { + t.Errorf("RepoType: expected local, got %s", api.RepoType) + } + if api.Description != "Internal Deb repository" { + t.Errorf("Description: expected 'Internal Deb repository', got %s", api.Description) + } +} + +func TestLocalDebModelToAPI_EmptyDescription(t *testing.T) { + model := localDebResourceModel{ + Name: types.StringValue("deb-empty"), + Description: types.StringValue(""), + } + + api := localDebModelToAPI(model) + + if api.Name != "deb-empty" { + t.Errorf("Name: expected deb-empty, got %s", api.Name) + } + if api.Description != "" { + t.Errorf("Description: expected empty string, got %s", api.Description) + } + if api.PackageType != "deb" { + t.Errorf("PackageType: expected deb, got %s", api.PackageType) + } + if api.RepoType != "local" { + t.Errorf("RepoType: expected local, got %s", api.RepoType) + } +} + +func TestLocalDebAPIToModel(t *testing.T) { + api := remoteAPI{ + Name: "deb-internal", + PackageType: "deb", + RepoType: "local", + Description: "Internal Deb repository", + ManagedBy: "terraform", + } + + model := localDebAPIToModel(api) + + if model.Name.ValueString() != "deb-internal" { + t.Errorf("Name: expected deb-internal, got %s", model.Name.ValueString()) + } + if model.Description.ValueString() != "Internal Deb repository" { + t.Errorf("Description: expected 'Internal Deb repository', got %s", model.Description.ValueString()) + } +} + +func TestLocalDebRoundTrip(t *testing.T) { + original := localDebResourceModel{ + Name: types.StringValue("roundtrip-deb"), + Description: types.StringValue("Round trip test"), + } + + api := localDebModelToAPI(original) + result := localDebAPIToModel(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 TestLocalDebResource_Metadata(t *testing.T) { + r := NewLocalDebResource() + req := resource.MetadataRequest{ProviderTypeName: "artifactapi"} + var resp resource.MetadataResponse + r.Metadata(context.Background(), req, &resp) + if resp.TypeName != "artifactapi_local_deb" { + t.Errorf("expected artifactapi_local_deb, got %s", resp.TypeName) + } +} + +func TestLocalDebResource_Schema(t *testing.T) { + r := NewLocalDebResource() + 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 TestNewLocalDebResource_Type(t *testing.T) { + r := NewLocalDebResource() + _, ok := r.(*localDebResource) + if !ok { + t.Error("expected *localDebResource") + } +} diff --git a/internal/provider/resource_remote.go b/internal/provider/resource_remote.go index af2a352..be6b445 100644 --- a/internal/provider/resource_remote.go +++ b/internal/provider/resource_remote.go @@ -62,6 +62,7 @@ func NewRemoteHelm() resource.Resource { return &remoteResource{packageType func NewRemotePyPI() resource.Resource { return &remoteResource{packageType: "pypi"} } func NewRemoteNPM() resource.Resource { return &remoteResource{packageType: "npm"} } func NewRemoteRPM() resource.Resource { return &remoteResource{packageType: "rpm"} } +func NewRemoteDeb() resource.Resource { return &remoteResource{packageType: "deb"} } func NewRemoteAlpine() resource.Resource { return &remoteResource{packageType: "alpine"} } func NewRemotePuppet() resource.Resource { return &remoteResource{packageType: "puppet"} } func NewRemoteTerraform() resource.Resource { return &remoteResource{packageType: "terraform"} }