KSM-388: Add custom field write support to resources

[stas-schaller]

Summary

Extends Terraform Provider custom field support to 5 field types (text, multiline, secret, url, email) across all 22 resource types, enabling users to add arbitrary custom fields to secrets stored in Keeper.

Changes

Extended Type Support

• 5 field types: text, multiline, secret, url, email
• 22 resource types: All standard, personal info, and PAM resources
• Full CRUD operations: Create, Read, Update for custom fields
• Type validation: Comprehensive tests for all field types

Implementation Details

Schema (record_fields.go):

• schemaCustomField(): Schema definition supporting type, label, value, required, privacy_screen
• convertFieldToMap(): Helper function for Update operations (converts SDK structs to RecordDict maps)

Resources (all 22 resource_*.go files):

• Create functions: Process custom fields using switch statement for 5 types
• Read functions: Extract custom fields from Record.RecordDict["custom"]
• Update functions: Handle custom field changes via RecordDict manipulation

Provider (provider.go):

• Added "custom": "custom" to field name mapping
• Uses existing getFieldItemsResourceData() for custom field reads

Resources Supporting Custom Fields

Standard Records (11):

• login, database_credentials, server_credentials, ssh_keys, encrypted_notes, driver_license, passport, birth_certificate, ssn_card, photo, file

Complex Nested Records (7):

• bank_account, bank_card, payment_card, contact, health_insurance, membership, software_license

PAM Records (4):

• pam_user, pam_machine, pam_database, pam_directory

Other (1):

• address

Tests Added

Representative Tests (4 tests covering all 22 resources):

1. TestAccResourceLogin_customFields - Covers 11 simple resources
2. TestAccResourceBankAccount_customFields - Covers 7 complex nested resources
3. TestAccResourcePamUser_customFields - Covers 4 PAM resources
4. TestAccResourceAddress_customFields - Covers address resource

Type Validation Test:

5. TestAccResourceLogin_customFieldTypes - Validates all 5 types (text, multiline, secret, url, email)

All tests verify:

• Create with 2 custom fields
• Update to 3 custom fields with value changes
• Correct persistence across operations

Supported Field Types

All 5 types share identical SDK structure ([]string value):

type Text struct {
    KeeperRecordField
    Required      bool     `json:"required,omitempty"`
    PrivacyScreen bool     `json:"privacyScreen,omitempty"`
    Value         []string `json:"value,omitempty"`
}
// Multiline, Secret, Url, Email have identical structure

Example Usage

resource "secretsmanager_login" "employee_account" {
  folder_uid = var.folder_uid
  title      = "Employee Portal"
  
  login {
    value = "john.doe@company.com"
  }
  
  password {
    value = "securepassword123"
  }
  
  # Text custom field
  custom {
    type  = "text"
    label = "Department"
    value = "Engineering"
  }
  
  # Multiline custom field
  custom {
    type  = "multiline"
    label = "Notes"
    value = "Line 1\nLine 2\nLine 3"
  }
  
  # Secret custom field
  custom {
    type  = "secret"
    label = "API Key"
    value = "sk_live_abc123..."
  }
  
  # URL custom field
  custom {
    type  = "url"
    label = "Dashboard"
    value = "https://dashboard.example.com"
  }
  
  # Email custom field
  custom {
    type  = "email"
    label = "Support Email"
    value = "support@example.com"
  }
}

Testing

Run all custom field tests:

export TF_ACC=1
export KEEPER_CREDENTIAL="$(cat ~/.keeper/credential)"
go test ./secretsmanager -v -run "TestAccResource.*_customField" -timeout 20m

Test Results:

=== RUN   TestAccResourceAddress_customFields
--- PASS: TestAccResourceAddress_customFields (2.45s)
=== RUN   TestAccResourceBankAccount_customFields
--- PASS: TestAccResourceBankAccount_customFields (1.40s)
=== RUN   TestAccResourceLogin_customFields
--- PASS: TestAccResourceLogin_customFields (1.33s)
=== RUN   TestAccResourceLogin_customFieldTypes
--- PASS: TestAccResourceLogin_customFieldTypes (2.48s)
=== RUN   TestAccResourcePamUser_customFields
--- PASS: TestAccResourcePamUser_customFields (4.16s)
PASS
ok  	github.com/keeper-security/terraform-provider-secretsmanager/secretsmanager	11.293s

Technical Details

Custom Field Storage

Custom fields are stored separately from standard fields:

• Standard fields: Record.RecordDict["fields"]
• Custom fields: Record.RecordDict["custom"]

CRUD Operations

Create: Uses typed SDK structs (core.Text, core.Multiline, etc.)

field := &core.Text{
    KeeperRecordField: core.KeeperRecordField{Type: "text"},
    Label: "Department",
    Value: []string{"Engineering"},
}
nrc.Custom = append(nrc.Custom, field)

Read: Extracts from RecordDict via getFieldItemsResourceData()

customItems := getFieldItemsResourceData("custom", secret)
d.Set("custom", customItems)

Update: Manipulates RecordDict directly

fieldMap := convertFieldToMap(f.Type, f.Label, f.Required, f.PrivacyScreen, f.Value)
customFields = append(customFields, fieldMap)
secret.RecordDict["custom"] = customFields

Related Issues

• GitHub Issue: Allow resources to have custom fields #16
• Jira: KSM-388

[stas-schaller]

PR closed due to force-push on release-v1.1.8. Recreated as PR #68 with updated base.