Skip to content

fix: preserve colon package names in catalog label assignments #417

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
omribz156 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix: preserve colon package names in catalog label assignments #417

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@ FEATURES:

* resource/xray_security_policy: Add `sast` block to `rule.criteria` for SAST policy rules with `min_severity` support. Only supported by JFrog Advanced Security. PR: [#407](https://github.com/jfrog/terraform-provider-xray/pull/407)

BUG FIXES:

* resource/xray_catalog_labels: Preserve package names containing `:` when updating package version assignments. Issue: [#415](https://github.com/jfrog/terraform-provider-xray/issues/415)

## 3.1.9 (April 07, 2026). Tested on JFrog Platform 11.4.6 (Artifactory 7.133.17, Xray 3.137.27, Catalog 1.35.0) with Terraform 1.14.8 and OpenTofu 1.11.5

IMPROVEMENTS:
Expand Down
17 changes: 17 additions & 0 deletions pkg/xray/resource/catalog_version_assignment_key_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
package xray

import "testing"

func TestNewVersionAssignmentKeyKeepsColonPackageNameIntact(t *testing.T) {
key := newVersionAssignmentKey("mysql:mysql-connector-java", "maven", "8.0.28")

if key.packageName != "mysql:mysql-connector-java" {
t.Fatalf("expected package name with colon to be preserved, got %q", key.packageName)
}
if key.packageType != "maven" {
t.Fatalf("expected package type maven, got %q", key.packageType)
}
if key.version != "8.0.28" {
t.Fatalf("expected version 8.0.28, got %q", key.version)
}
}
44 changes: 27 additions & 17 deletions pkg/xray/resource/resource_catalog_labels.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,20 @@ type versionAssignmentExpanded struct {
version string
}

type versionAssignmentKey struct {
packageName string
packageType string
version string
}

func newVersionAssignmentKey(packageName, packageType, version string) versionAssignmentKey {
return versionAssignmentKey{
packageName: packageName,
packageType: packageType,
version: version,
}
}

func (r *CatalogLabelsResource) Configure(ctx context.Context, req resource.ConfigureRequest, resp *resource.ConfigureResponse) {
// Prevent panic if the provider has not been configured.
if req.ProviderData == nil {
Expand Down Expand Up @@ -383,7 +397,7 @@ func (r *CatalogLabelsResource) validatePackageVersionAssignmentRedundancyInPlan
}

// Build set of versions present in state (if provided)
stateKeys := make(map[string]struct{})
stateKeys := make(map[versionAssignmentKey]struct{})
if state != nil && !state.VersionAssignments.IsNull() && !state.VersionAssignments.IsUnknown() {
var sassign []VersionAssignmentModel
if diags := state.VersionAssignments.ElementsAs(ctx, &sassign, false); !diags.HasError() {
Expand All @@ -392,7 +406,7 @@ func (r *CatalogLabelsResource) validatePackageVersionAssignmentRedundancyInPlan
if !a.Versions.IsNull() && !a.Versions.IsUnknown() && len(a.Versions.Elements()) > 0 {
if d2 := a.Versions.ElementsAs(ctx, &vs, false); !d2.HasError() {
for _, v := range vs {
key := fmt.Sprintf("%s:%s:%s", a.PackageName.ValueString(), a.PackageType.ValueString(), v)
key := newVersionAssignmentKey(a.PackageName.ValueString(), a.PackageType.ValueString(), v)
stateKeys[key] = struct{}{}
}
}
Expand All @@ -419,7 +433,7 @@ func (r *CatalogLabelsResource) validatePackageVersionAssignmentRedundancyInPlan
}
if len(assigned) > 0 {
// Skip error if this exact package:version is already tracked in state
key := fmt.Sprintf("%s:%s:%s", a.PackageName.ValueString(), a.PackageType.ValueString(), v)
key := newVersionAssignmentKey(a.PackageName.ValueString(), a.PackageType.ValueString(), v)
if _, ok := stateKeys[key]; ok {
continue
}
Expand Down Expand Up @@ -1327,25 +1341,25 @@ func (r *CatalogLabelsResource) Update(ctx context.Context, req resource.UpdateR
}

// Expand to per-version mapping
planVerMap := map[string]string{} // key -> label
planVerMap := map[versionAssignmentKey]string{} // key -> label
for _, a := range planVers {
var vs []string
if !a.Versions.IsNull() && !a.Versions.IsUnknown() && len(a.Versions.Elements()) > 0 {
if diags := a.Versions.ElementsAs(ctx, &vs, false); !diags.HasError() {
for _, v := range vs {
key := fmt.Sprintf("%s:%s:%s", a.PackageName.ValueString(), a.PackageType.ValueString(), v)
key := newVersionAssignmentKey(a.PackageName.ValueString(), a.PackageType.ValueString(), v)
planVerMap[key] = a.LabelName.ValueString()
}
}
}
}
stateVerMap := map[string]string{}
stateVerMap := map[versionAssignmentKey]string{}
for _, a := range stateVers {
var vs []string
if !a.Versions.IsNull() && !a.Versions.IsUnknown() && len(a.Versions.Elements()) > 0 {
if diags := a.Versions.ElementsAs(ctx, &vs, false); !diags.HasError() {
for _, v := range vs {
key := fmt.Sprintf("%s:%s:%s", a.PackageName.ValueString(), a.PackageType.ValueString(), v)
key := newVersionAssignmentKey(a.PackageName.ValueString(), a.PackageType.ValueString(), v)
stateVerMap[key] = a.LabelName.ValueString()
}
}
Expand All @@ -1358,14 +1372,12 @@ func (r *CatalogLabelsResource) Update(ctx context.Context, req resource.UpdateR
var toRemove []VersionAssignmentModel
for key, stateLabel := range stateVerMap {
if _, ok := planVerMap[key]; !ok {
parts := strings.SplitN(key, ":", 3)
pkgName, pkgType, version := parts[0], parts[1], parts[2]
vm := VersionAssignmentModel{
LabelName: types.StringValue(stateLabel),
PackageName: types.StringValue(pkgName),
PackageType: types.StringValue(pkgType),
PackageName: types.StringValue(key.packageName),
PackageType: types.StringValue(key.packageType),
}
versSet, _ := types.SetValueFrom(ctx, types.StringType, []string{version})
versSet, _ := types.SetValueFrom(ctx, types.StringType, []string{key.version})
vm.Versions = versSet
toRemove = append(toRemove, vm)
}
Expand All @@ -1386,15 +1398,13 @@ func (r *CatalogLabelsResource) Update(ctx context.Context, req resource.UpdateR
var toAdd []VersionAssignmentModel
for key, planLabel := range planVerMap {
stateLabel, ok := stateVerMap[key]
parts := strings.SplitN(key, ":", 3)
pkgName, pkgType, version := parts[0], parts[1], parts[2]
if !ok || stateLabel != planLabel {
vm := VersionAssignmentModel{
LabelName: types.StringValue(planLabel),
PackageName: types.StringValue(pkgName),
PackageType: types.StringValue(pkgType),
PackageName: types.StringValue(key.packageName),
PackageType: types.StringValue(key.packageType),
}
versSet, _ := types.SetValueFrom(ctx, types.StringType, []string{version})
versSet, _ := types.SetValueFrom(ctx, types.StringType, []string{key.version})
vm.Versions = versSet
toAdd = append(toAdd, vm)
}
Expand Down
Loading