terraform/tf_provider
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

refactor: shared YAML types via tf-tools/lib (yaml-generator + resource-generator)

Browse Source 
TOOLS/lib/types.go — canonical ServiceSpec, ParamSpec, OperationSpec, OutputParam.
Both generators use type aliases, one source of truth for YAML contract.
docs-generator stays as-is (will be replaced by LLM-based generator).
This commit is contained in:
“Naeel”
2026-07-06 09:40:59 +04:00
parent 53d03004de
commit b56e634796
8 changed files with 137 additions and 131 deletions
Download Patch File Download Diff File Expand all files Collapse all files
TOOLS/lib/go.mod
+1 -3
View File
@@ -1,5 +1,3 @@
module lib
module tf-tools/lib
go 1.24
require gopkg.in/yaml.v3 v3.0.1
TOOLS/lib/types.go
+19 -20
View File
@@ -1,4 +1,3 @@
package lib
// Package lib — общие типы YAML-контракта для всех генераторов.
//
// Это КАНОНИЧЕСКОЕ определение YAML-спеков. Все генераторы используют эти типы.
@@ -52,25 +51,25 @@ type OperationSpec struct {
// Поля без тега — специфичны для конкретного генератора (заполняются при обработке).
type ParamSpec struct {
// === YAML-контракт (канонические поля) ===
ID int `yaml:"id"`
Code string `yaml:"code"`
DataType string `yaml:"data_type,omitempty"`
Type string `yaml:"type,omitempty"`
Required bool `yaml:"required"`
Default interface{} `yaml:"default,omitempty"`
ValueList []string `yaml:"value_list,omitempty"`
RefSvcID *int `yaml:"ref_svc_id,omitempty"`
Func string `yaml:"func,omitempty"`
Regex string `yaml:"regex,omitempty"`
Unique string `yaml:"unique_scope,omitempty"`
MaxLength *int `yaml:"maxlength,omitempty"`
MinLength *int `yaml:"minlength,omitempty"`
MaxValue interface{} `yaml:"maxvalue,omitempty"`
MinValue interface{} `yaml:"minvalue,omitempty"`
Descr string `yaml:"descr,omitempty"`
Man string `yaml:"man,omitempty"`
Sort *int `yaml:"sort,omitempty"`
DependsOn interface{} `yaml:"depends_on,omitempty"`
ID int `yaml:"id"`
Code string `yaml:"code"`
DataType string `yaml:"data_type,omitempty"`
Type string `yaml:"type,omitempty"`
Required bool `yaml:"required"`
Default interface{} `yaml:"default,omitempty"`
ValueList []string `yaml:"value_list,omitempty"`
RefSvcID *int `yaml:"ref_svc_id,omitempty"`
Func string `yaml:"func,omitempty"`
Regex string `yaml:"regex,omitempty"`
UniqueScope string `yaml:"unique_scope,omitempty"`
MaxLength *int `yaml:"maxlength,omitempty"`
MinLength *int `yaml:"minlength,omitempty"`
MaxValue interface{} `yaml:"maxvalue,omitempty"`
MinValue interface{} `yaml:"minvalue,omitempty"`
Descr string `yaml:"descr,omitempty"`
Man string `yaml:"man,omitempty"`
Sort *int `yaml:"sort,omitempty"`
DependsOn interface{} `yaml:"depends_on,omitempty"`
// === Генератор-специфичные поля (не сериализуются в YAML) ===
IsModifiable *bool `yaml:"is_modifiable,omitempty"`
TOOLS/resource-generator/go.mod
+4
View File
@@ -3,3 +3,7 @@ module resource-generator
go 1.24
require gopkg.in/yaml.v3 v3.0.1
require tf-tools/lib v0.0.0
replace tf-tools/lib => ../lib
TOOLS/resource-generator/internal/loader/loader.go
+3 -3
View File
@@ -226,8 +226,8 @@ func ConvertParams(params []types.ParamSpec) []types.Param {
typeName := NormalizeParamType(p.DataType)
defVal := NormalizeDefault(p.Default)
ref := 0
if p.RefSvcId != nil {
ref = *p.RefSvcId
if p.RefSvcID != nil {
ref = *p.RefSvcID
}
out = append(out, types.Param{
ID: p.ID,
@@ -238,7 +238,7 @@ func ConvertParams(params []types.ParamSpec) []types.Param {
RefSvcId: ref,
Descr: strings.TrimSpace(p.Descr),
Man: strings.TrimSpace(p.Man),
Sensitive: p.Sensitive,
Sensitive: p.IsSensitive,
IsJson: strings.EqualFold(strings.TrimSpace(p.DataType), "json"),
})
}
TOOLS/resource-generator/internal/types/types.go
+8 -31
View File
@@ -11,41 +11,18 @@
// - всё остальное → отдельный GenAction
package types
// ─── Входные структуры (из YAML) ───────────────────────────────────────────
import "tf-tools/lib"
// ParamSpec — один параметр операции как он описан в YAML.
// Соответствует cfsParam из API Nubes.
type ParamSpec struct {
ID int `yaml:"id"` // svcOperationCfsParamId
Code string `yaml:"code"` // имя параметра (camelCase)
DataType string `yaml:"data_type,omitempty"` // string | integer > 0 | boolean | map-fixed | uuid | json | ...
Required bool `yaml:"required"` // обязательный?
Default interface{} `yaml:"default,omitempty"` // значение по умолчанию (строка или число)
RefSvcId *int `yaml:"ref_svc_id,omitempty"` // ссылка на другой сервис (UUID-параметр)
Descr string `yaml:"descr,omitempty"` // описание
Man string `yaml:"man,omitempty"` // MAN-руководство
Sensitive bool `yaml:"is_sensitive,omitempty"` // секретный параметр?
}
// ─── Алиасы к lib (общий YAML-контракт) ─────────────────────────────────────
// OutputParam — выходной параметр сервиса (state_params, vault_secrets, ...).
type OutputParam struct {
Code string `yaml:"code"` // код: state_params, state_out, vault_url, ...
Type string `yaml:"type"` // map | string | list
Sensitive bool `yaml:"sensitive,omitempty"` // vault_secrets = true
}
type OutputParam = lib.OutputParam
type OperationSpec = lib.OperationSpec
type ParamSpec = lib.ParamSpec
// OperationSpec — одна операция сервиса (create, modify, delete_user, ...).
type OperationSpec struct {
Name string `yaml:"name"` // имя операции (create, modify, ...)
ID int `yaml:"id"` // svcOperationId
Kind string `yaml:"kind"` // instance | subresource | action
Action string `yaml:"action"` // create | modify | delete | suspend | redeploy | ...
Subresource string `yaml:"subresource,omitempty"` // для subresource: user, database, topic, ...
Man string `yaml:"man,omitempty"` // MAN-руководство операции
Params []ParamSpec `yaml:"params"` // параметры операции
}
// ─── Входные структуры (из YAML) — локальное определение ────────────────────
// ServiceSpec — полная YAML-спецификация одного сервиса.
// ServiceSpec — локальное определение (отличается вложенными типами от lib).
// Использует *bool для Lifecycle (совместимость с YAML-парсингом).
type ServiceSpec struct {
Name string `yaml:"name"` // snake_case имя (postgres, s3bucket, ...)
ServiceID int `yaml:"service_id"` // числовой ID сервиса в Nubes
TOOLS/yaml-generator/go.mod
+4
View File
@@ -3,3 +3,7 @@ module yaml-generator
go 1.24
require gopkg.in/yaml.v3 v3.0.1
require tf-tools/lib v0.0.0-00010101000000-000000000000
replace tf-tools/lib => ../lib
TOOLS/yaml-generator/internal/types/types.go
+12 -74
View File
@@ -1,16 +1,12 @@
// Package types — структуры данных для YAML-спеков сервисов.
//
// Содержит два набора типов:
// - API-ответы (ServiceResponse, ServiceInfo, CfsParam, ...) —
// соответствуют JSON-структурам Nubes API /services/{id} и /serviceOperation/{id}.
// - Выходные YAML-типы (ServiceSpec, ParamSpec, OperationSpec, ...) —
// сериализуются в resources_yaml/*.yaml и читаются генераторами resource-generator и docs-generator.
//
// Разделение API-входа и YAML-выхода позволяет менять формат YAML
// независимо от структуры API.
// API-ответы — собственные типы.
// YAML-типы — алиасы к lib (общий контракт).
package types
// ─── API-ответы ─────────────────────────────────────────────────────────────
import "tf-tools/lib"
// ─── API-ответы (специфичны для yaml-generator, не из lib) ──────────────────
// ServiceResponse — ответ /services/{id}.
type ServiceResponse struct {
@@ -69,69 +65,11 @@ type CfsParam struct {
IsSensitive bool `json:"isSensitive"`
}
// ─── Выходные структуры (YAML) ──────────────────────────────────────────────
// ─── YAML-типы (алиасы к lib — общий контракт) ─────────────────────────────
// ServiceSpec — полная YAML-спецификация сервиса.
type ServiceSpec struct {
Name string `yaml:"name"`
ServiceID int `yaml:"service_id"`
ServiceDisplayName string `yaml:"service_display_name,omitempty"`
ServiceShortName string `yaml:"service_short_name,omitempty"`
ServiceMan string `yaml:"service_man,omitempty"`
Lifecycle Lifecycle `yaml:"lifecycle"`
Outputs OutputSection `yaml:"outputs"`
Operations []OperationSpec `yaml:"operations"`
}
// Lifecycle — настройки жизненного цикла сервиса.
type Lifecycle struct {
SuspendOnDestroyDefault bool `yaml:"suspend_on_destroy_default"`
AdoptExistingOnCreateDefault bool `yaml:"adopt_existing_on_create_default"`
}
// OutputSection — секция выходных параметров.
type OutputSection struct {
Params []OutputParam `yaml:"params"`
}
// OutputParam — выходной параметр (state_params, vault_secrets, ...).
type OutputParam struct {
Code string `yaml:"code"`
Type string `yaml:"type"`
Sensitive bool `yaml:"sensitive,omitempty"`
}
// OperationSpec — одна операция в YAML-спеке.
type OperationSpec struct {
Name string `yaml:"name"`
ID int `yaml:"id"`
Kind string `yaml:"kind"`
Action string `yaml:"action"`
Subresource string `yaml:"subresource,omitempty"`
Man string `yaml:"man,omitempty"`
Params []ParamSpec `yaml:"params"`
}
// ParamSpec — параметр операции в YAML-спеке.
type ParamSpec struct {
ID int `yaml:"id"`
Code string `yaml:"code"`
DataType string `yaml:"data_type,omitempty"`
Required bool `yaml:"required"`
Default interface{} `yaml:"default,omitempty"`
ValueList []string `yaml:"value_list,omitempty"`
RefSvcID *int `yaml:"ref_svc_id,omitempty"`
Func string `yaml:"func,omitempty"`
Regex string `yaml:"regex,omitempty"`
UniqueScope string `yaml:"unique_scope,omitempty"`
MaxLength *int `yaml:"maxlength,omitempty"`
MinLength *int `yaml:"minlength,omitempty"`
MaxValue interface{} `yaml:"maxvalue,omitempty"`
MinValue interface{} `yaml:"minvalue,omitempty"`
Descr string `yaml:"descr,omitempty"`
Man string `yaml:"man,omitempty"`
Sort *int `yaml:"sort,omitempty"`
DependsOn interface{} `yaml:"depends_on,omitempty"`
IsModifiable *bool `yaml:"is_modifiable,omitempty"`
IsSensitive bool `yaml:"is_sensitive,omitempty"`
}
type ServiceSpec = lib.ServiceSpec
type Lifecycle = lib.Lifecycle
type OutputSection = lib.OutputSection
type OutputParam = lib.OutputParam
type OperationSpec = lib.OperationSpec
type ParamSpec = lib.ParamSpec