Add artifactapi_local_alpine resource
ci/woodpecker/pr/build Pipeline was successful
ci/woodpecker/pr/test Pipeline was successful
ci/woodpecker/pr/pre-commit Pipeline was successful

Adds a local Alpine/apk repository resource mirroring the existing
artifactapi_local_deb and artifactapi_local_rpm locals, so Alpine
package registries can be managed directly via Terraform.

- add localAlpineResource (PackageType alpine, RepoType local) with
  CRUD + import passthrough and model<->API mappers
- register NewLocalAlpineResource in provider Resources()
- bump provider_test resource count to 21 and expected type list
- add local unit tests and README/example entries
This commit is contained in:
2026-08-12 00:52:33 +10:00
parent b8c18690ef
commit cb1110c723
6 changed files with 298 additions and 2 deletions
+1
View File
@@ -155,6 +155,7 @@ Available resource types:
- `artifactapi_local_pypi`
- `artifactapi_local_rpm`
- `artifactapi_local_deb`
- `artifactapi_local_alpine`
- `artifactapi_local_terraform`
Each takes just `name` (required, forces replacement) and an optional
@@ -0,0 +1,4 @@
resource "artifactapi_local_alpine" "internal" {
name = "alpine-internal"
description = "Internal Alpine package repository"
}
+1
View File
@@ -75,6 +75,7 @@ func (p *ArtifactAPIProvider) Resources(_ context.Context) []func() resource.Res
NewLocalPyPIResource,
NewLocalRPMResource,
NewLocalDebResource,
NewLocalAlpineResource,
NewLocalDockerResource,
NewLocalGenericResource,
}
+3 -2
View File
@@ -66,8 +66,8 @@ func TestProvider_Resources(t *testing.T) {
p := &ArtifactAPIProvider{version: "1.0.0"}
resources := p.Resources(context.Background())
// 13 remote resource types + 1 virtual + local_terraform/pypi/rpm/deb/docker/generic = 20
expectedCount := 20
// 13 remote resource types + 1 virtual + local_terraform/pypi/rpm/deb/alpine/docker/generic = 21
expectedCount := 21
if len(resources) != expectedCount {
t.Fatalf("expected %d resources, got %d", expectedCount, len(resources))
}
@@ -114,6 +114,7 @@ func TestProvider_Resources_ContainsExpectedTypes(t *testing.T) {
"artifactapi_local_pypi",
"artifactapi_local_rpm",
"artifactapi_local_deb",
"artifactapi_local_alpine",
"artifactapi_local_docker",
"artifactapi_local_generic",
}
+164
View File
@@ -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 = &localAlpineResource{}
_ resource.ResourceWithImportState = &localAlpineResource{}
)
type localAlpineResource struct {
client *apiClient
}
type localAlpineResourceModel struct {
Name types.String `tfsdk:"name"`
Description types.String `tfsdk:"description"`
}
func NewLocalAlpineResource() resource.Resource {
return &localAlpineResource{}
}
func (r *localAlpineResource) Metadata(_ context.Context, req resource.MetadataRequest, resp *resource.MetadataResponse) {
resp.TypeName = req.ProviderTypeName + "_local_alpine"
}
func (r *localAlpineResource) Schema(_ context.Context, _ resource.SchemaRequest, resp *resource.SchemaResponse) {
resp.Schema = schema.Schema{
Description: "Manages a local ArtifactAPI Alpine repository for hosting Alpine/apk packages directly.",
Attributes: map[string]schema.Attribute{
"name": schema.StringAttribute{
Description: "Unique name of the local Alpine repository.",
Required: true,
PlanModifiers: []planmodifier.String{
stringplanmodifier.RequiresReplace(),
},
},
"description": schema.StringAttribute{
Description: "Human-readable description.",
Optional: true,
Computed: true,
Default: stringdefault.StaticString(""),
},
},
}
}
func (r *localAlpineResource) 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 *localAlpineResource) Create(ctx context.Context, req resource.CreateRequest, resp *resource.CreateResponse) {
var plan localAlpineResourceModel
resp.Diagnostics.Append(req.Plan.Get(ctx, &plan)...)
if resp.Diagnostics.HasError() {
return
}
api := localAlpineModelToAPI(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 alpine failed", err.Error())
return
}
state := localAlpineAPIToModel(created)
resp.Diagnostics.Append(resp.State.Set(ctx, state)...)
}
func (r *localAlpineResource) Read(ctx context.Context, req resource.ReadRequest, resp *resource.ReadResponse) {
var state localAlpineResourceModel
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 alpine failed", err.Error())
return
}
newState := localAlpineAPIToModel(remote)
resp.Diagnostics.Append(resp.State.Set(ctx, newState)...)
}
func (r *localAlpineResource) Update(ctx context.Context, req resource.UpdateRequest, resp *resource.UpdateResponse) {
var plan localAlpineResourceModel
resp.Diagnostics.Append(req.Plan.Get(ctx, &plan)...)
if resp.Diagnostics.HasError() {
return
}
api := localAlpineModelToAPI(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 alpine failed", err.Error())
return
}
state := localAlpineAPIToModel(updated)
resp.Diagnostics.Append(resp.State.Set(ctx, state)...)
}
func (r *localAlpineResource) Delete(ctx context.Context, req resource.DeleteRequest, resp *resource.DeleteResponse) {
var state localAlpineResourceModel
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 alpine failed", err.Error())
return
}
}
func (r *localAlpineResource) ImportState(ctx context.Context, req resource.ImportStateRequest, resp *resource.ImportStateResponse) {
resource.ImportStatePassthroughID(ctx, path.Root("name"), req, resp)
}
func localAlpineModelToAPI(m localAlpineResourceModel) remoteAPI {
return remoteAPI{
Name: m.Name.ValueString(),
PackageType: "alpine",
RepoType: "local",
Description: m.Description.ValueString(),
}
}
func localAlpineAPIToModel(api remoteAPI) localAlpineResourceModel {
return localAlpineResourceModel{
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 TestLocalAlpineModelToAPI(t *testing.T) {
model := localAlpineResourceModel{
Name: types.StringValue("alpine-internal"),
Description: types.StringValue("Internal Alpine repository"),
}
api := localAlpineModelToAPI(model)
if api.Name != "alpine-internal" {
t.Errorf("Name: expected alpine-internal, got %s", api.Name)
}
if api.PackageType != "alpine" {
t.Errorf("PackageType: expected alpine, got %s", api.PackageType)
}
if api.RepoType != "local" {
t.Errorf("RepoType: expected local, got %s", api.RepoType)
}
if api.Description != "Internal Alpine repository" {
t.Errorf("Description: expected 'Internal Alpine repository', got %s", api.Description)
}
}
func TestLocalAlpineModelToAPI_EmptyDescription(t *testing.T) {
model := localAlpineResourceModel{
Name: types.StringValue("alpine-empty"),
Description: types.StringValue(""),
}
api := localAlpineModelToAPI(model)
if api.Name != "alpine-empty" {
t.Errorf("Name: expected alpine-empty, got %s", api.Name)
}
if api.Description != "" {
t.Errorf("Description: expected empty string, got %s", api.Description)
}
if api.PackageType != "alpine" {
t.Errorf("PackageType: expected alpine, got %s", api.PackageType)
}
if api.RepoType != "local" {
t.Errorf("RepoType: expected local, got %s", api.RepoType)
}
}
func TestLocalAlpineAPIToModel(t *testing.T) {
api := remoteAPI{
Name: "alpine-internal",
PackageType: "alpine",
RepoType: "local",
Description: "Internal Alpine repository",
ManagedBy: "terraform",
}
model := localAlpineAPIToModel(api)
if model.Name.ValueString() != "alpine-internal" {
t.Errorf("Name: expected alpine-internal, got %s", model.Name.ValueString())
}
if model.Description.ValueString() != "Internal Alpine repository" {
t.Errorf("Description: expected 'Internal Alpine repository', got %s", model.Description.ValueString())
}
}
func TestLocalAlpineRoundTrip(t *testing.T) {
original := localAlpineResourceModel{
Name: types.StringValue("roundtrip-alpine"),
Description: types.StringValue("Round trip test"),
}
api := localAlpineModelToAPI(original)
result := localAlpineAPIToModel(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 TestLocalAlpineResource_Metadata(t *testing.T) {
r := NewLocalAlpineResource()
req := resource.MetadataRequest{ProviderTypeName: "artifactapi"}
var resp resource.MetadataResponse
r.Metadata(context.Background(), req, &resp)
if resp.TypeName != "artifactapi_local_alpine" {
t.Errorf("expected artifactapi_local_alpine, got %s", resp.TypeName)
}
}
func TestLocalAlpineResource_Schema(t *testing.T) {
r := NewLocalAlpineResource()
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 TestNewLocalAlpineResource_Type(t *testing.T) {
r := NewLocalAlpineResource()
_, ok := r.(*localAlpineResource)
if !ok {
t.Error("expected *localAlpineResource")
}
}