kubernetes
/
kops
mirror of https://github.com/kubernetes/kops.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #14680 from johngmyers/literal-refactor 

Refactor terraformWriter.Literal
This commit is contained in:
Kubernetes Prow Robot 2022-11-27 18:34:13 -08:00 committed by GitHub
parent 8495bbdb12 8b6f2973f8
commit 545931f9b7
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
10 changed files with 65 additions and 188 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
tests/integration/update_cluster/complex/kubernetes.tf
View File

@ -1,11 +1,11 @@
locals {
cluster_name = "complex.example.com"
master_autoscaling_group_ids = [aws_autoscaling_group.master-us-test-1a-masters-complex-example-com.id]
master_security_group_ids = [aws_security_group.masters-complex-example-com.id, "sg-exampleid5", "sg-exampleid6"]
master_security_group_ids = ["sg-exampleid5", "sg-exampleid6", aws_security_group.masters-complex-example-com.id]
masters_role_arn = aws_iam_role.masters-complex-example-com.arn
masters_role_name = aws_iam_role.masters-complex-example-com.name
node_autoscaling_group_ids = [aws_autoscaling_group.nodes-complex-example-com.id]
node_security_group_ids = [aws_security_group.nodes-complex-example-com.id, "sg-exampleid3", "sg-exampleid4"]
node_security_group_ids = ["sg-exampleid3", "sg-exampleid4", aws_security_group.nodes-complex-example-com.id]
node_subnet_ids = [aws_subnet.us-test-1a-complex-example-com.id]
nodes_role_arn = aws_iam_role.nodes-complex-example-com.arn
nodes_role_name = aws_iam_role.nodes-complex-example-com.name
@ -30,7 +30,7 @@ output "master_autoscaling_group_ids" {
}
output "master_security_group_ids" {
value = [aws_security_group.masters-complex-example-com.id, "sg-exampleid5", "sg-exampleid6"]
value = ["sg-exampleid5", "sg-exampleid6", aws_security_group.masters-complex-example-com.id]
}
output "masters_role_arn" {
@ -46,7 +46,7 @@ output "node_autoscaling_group_ids" {
}
output "node_security_group_ids" {
value = [aws_security_group.nodes-complex-example-com.id, "sg-exampleid3", "sg-exampleid4"]
value = ["sg-exampleid3", "sg-exampleid4", aws_security_group.nodes-complex-example-com.id]
}
output "node_subnet_ids" {

4
tests/integration/update_cluster/existing_sg/kubernetes.tf
View File

@ -1,7 +1,7 @@
locals {
cluster_name = "existingsg.example.com"
master_autoscaling_group_ids = [aws_autoscaling_group.master-us-test-1a-masters-existingsg-example-com.id, aws_autoscaling_group.master-us-test-1b-masters-existingsg-example-com.id, aws_autoscaling_group.master-us-test-1c-masters-existingsg-example-com.id]
master_security_group_ids = [aws_security_group.masters-existingsg-example-com.id, "sg-master-1a", "sg-master-1b"]
master_security_group_ids = ["sg-master-1a", "sg-master-1b", aws_security_group.masters-existingsg-example-com.id]
masters_role_arn = aws_iam_role.masters-existingsg-example-com.arn
masters_role_name = aws_iam_role.masters-existingsg-example-com.name
node_autoscaling_group_ids = [aws_autoscaling_group.nodes-existingsg-example-com.id]
@ -29,7 +29,7 @@ output "master_autoscaling_group_ids" {
}
output "master_security_group_ids" {
value = [aws_security_group.masters-existingsg-example-com.id, "sg-master-1a", "sg-master-1b"]
value = ["sg-master-1a", "sg-master-1b", aws_security_group.masters-existingsg-example-com.id]
}
output "masters_role_arn" {

6
tests/integration/update_cluster/externalpolicies/kubernetes.tf
View File

@ -5,7 +5,7 @@ locals {
masters_role_arn = aws_iam_role.masters-externalpolicies-example-com.arn
masters_role_name = aws_iam_role.masters-externalpolicies-example-com.name
node_autoscaling_group_ids = [aws_autoscaling_group.nodes-externalpolicies-example-com.id]
node_security_group_ids = [aws_security_group.nodes-externalpolicies-example-com.id, "sg-exampleid3", "sg-exampleid4"]
node_security_group_ids = ["sg-exampleid3", "sg-exampleid4", aws_security_group.nodes-externalpolicies-example-com.id]
node_subnet_ids = [aws_subnet.us-test-1a-externalpolicies-example-com.id]
nodes_role_arn = aws_iam_role.nodes-externalpolicies-example-com.arn
nodes_role_name = aws_iam_role.nodes-externalpolicies-example-com.name
@ -43,7 +43,7 @@ output "node_autoscaling_group_ids" {
}
output "node_security_group_ids" {
value = [aws_security_group.nodes-externalpolicies-example-com.id, "sg-exampleid3", "sg-exampleid4"]
value = ["sg-exampleid3", "sg-exampleid4", aws_security_group.nodes-externalpolicies-example-com.id]
}
output "node_subnet_ids" {
@ -294,7 +294,7 @@ resource "aws_elb" "api-externalpolicies-example-com" {
lb_protocol = "TCP"
}
name = "api-externalpolicies-exam-5cse45"
security_groups = [aws_security_group.api-elb-externalpolicies-example-com.id, "sg-exampleid3", "sg-exampleid4"]
security_groups = ["sg-exampleid3", "sg-exampleid4", aws_security_group.api-elb-externalpolicies-example-com.id]
subnets = [aws_subnet.us-test-1a-externalpolicies-example-com.id]
tags = {
"KubernetesCluster" = "externalpolicies.example.com"

75
upup/pkg/fi/cloudup/terraform/hcl2.go
View File

@ -20,7 +20,6 @@ import (
"reflect"
"sort"
"github.com/hashicorp/hcl/v2"
"github.com/hashicorp/hcl/v2/hclsyntax"
"github.com/hashicorp/hcl/v2/hclwrite"
"github.com/zclconf/go-cty/cty"
@ -102,61 +101,12 @@ func writeValue(body *hclwrite.Body, key string, value cty.Value) {
// key = res_type.res_name.res_prop
// key = file("${module.path}/foo")
func writeLiteral(body *hclwrite.Body, key string, literal *terraformWriter.Literal) {
if literal.String != "" {
body.SetAttributeRaw(key, hclwrite.Tokens{
{
Type: hclsyntax.TokenIdent,
Bytes: []byte(literal.String),
},
})
} else if literal.Index {
tokens := hclwrite.Tokens{
{
Type: hclsyntax.TokenOQuote,
Bytes: []byte(`"`),
},
{
Type: hclsyntax.TokenQuotedLit,
Bytes: []byte(literal.Value),
},
{
Type: hclsyntax.TokenQuotedLit,
Bytes: []byte(`-`),
},
{
Type: hclsyntax.TokenTemplateInterp,
Bytes: []byte(`${`),
},
{
Type: hclsyntax.TokenQuotedLit,
Bytes: []byte(`count.index`),
},
{
Type: hclsyntax.TokenTemplateSeqEnd,
Bytes: []byte(`}`),
},
{
Type: hclsyntax.TokenCQuote,
Bytes: []byte(`"`),
},
{
Type: hclsyntax.TokenEOF,
Bytes: []byte{},
},
}
body.SetAttributeRaw(key, tokens)
} else if len(literal.Tokens) == 0 {
body.SetAttributeValue(key, cty.StringVal(literal.Value))
} else {
traversal := hcl.Traversal{
hcl.TraverseRoot{Name: literal.Tokens[0]},
}
for i := 1; i < len(literal.Tokens); i++ {
token := literal.Tokens[i]
traversal = append(traversal, hcl.TraverseAttr{Name: token})
}
body.SetAttributeTraversal(key, traversal)
}
}
// literalListTokens returns the tokens of a list of literals
@ -167,22 +117,7 @@ func literalListTokens(literals []*terraformWriter.Literal) hclwrite.Tokens {
{Type: hclsyntax.TokenOBrack, Bytes: []byte("["), SpacesBefore: 1},
}
for i, literal := range literals {
if len(literal.Tokens) == 0 {
tokens = append(tokens, []*hclwrite.Token{
{Type: hclsyntax.TokenOQuote, Bytes: []byte{'"'}, SpacesBefore: 1},
{Type: hclsyntax.TokenQuotedLit, Bytes: []byte(literal.Value)},
{Type: hclsyntax.TokenCQuote, Bytes: []byte{'"'}, SpacesBefore: 1},
}...)
} else {
tokens = append(tokens, &hclwrite.Token{Type: hclsyntax.TokenStringLit, Bytes: []byte(literal.Tokens[0]), SpacesBefore: 1})
for i := 1; i < len(literal.Tokens); i++ {
token := literal.Tokens[i]
tokens = append(tokens, []*hclwrite.Token{
{Type: hclsyntax.TokenDot, Bytes: []byte(".")},
{Type: hclsyntax.TokenStringLit, Bytes: []byte(token)},
}...)
}
}
tokens = append(tokens, &hclwrite.Token{Type: hclsyntax.TokenIdent, Bytes: []byte(literal.String)})
if i < len(literals)-1 {
tokens = append(tokens, &hclwrite.Token{Type: hclsyntax.TokenComma, Bytes: []byte(",")})
}
@ -239,18 +174,10 @@ func writeMap(body *hclwrite.Body, key string, values map[string]cty.Value) {
errLiteralSlice := gocty.FromCtyValue(v, refLiteralSlice.Interface())
// If this is a map of literals then do not surround the value with quotes
if literal, ok := refLiteral.Interface().(*terraformWriter.Literal); errLiteral == nil && ok {
if literal.String != "" {
tokens = append(tokens, &hclwrite.Token{
Type: hclsyntax.TokenIdent,
Bytes: []byte(literal.String),
})
} else if literal.Value != "" {
tokens = append(tokens, []*hclwrite.Token{
{Type: hclsyntax.TokenOQuote, Bytes: []byte{'"'}, SpacesBefore: 1},
{Type: hclsyntax.TokenQuotedLit, Bytes: []byte(literal.Value)},
{Type: hclsyntax.TokenOQuote, Bytes: []byte{'"'}, SpacesBefore: 1},
}...)
}
} else if literals, ok := refLiteralSlice.Interface().(*[]*terraformWriter.Literal); errLiteralSlice == nil && ok {
tokens = append(tokens, literalListTokens(*literals)...)
} else {

10
upup/pkg/fi/cloudup/terraform/hcl2_test.go
View File

@ -167,7 +167,7 @@ func TestWriteLiteralList(t *testing.T) {
name: "one literal",
literals: []*terraformWriter.Literal{
{
Tokens: []string{"type", "name", "prop"},
String: "type.name.prop",
},
},
expected: "foo = [type.name.prop]",
@ -176,10 +176,10 @@ func TestWriteLiteralList(t *testing.T) {
name: "two literals",
literals: []*terraformWriter.Literal{
{
Tokens: []string{"type1", "name1", "prop1"},
String: "type1.name1.prop1",
},
{
Tokens: []string{"type2", "name2", "prop2"},
String: "type2.name2.prop2",
},
},
expected: "foo = [type1.name1.prop1, type2.name2.prop2]",
@ -188,10 +188,10 @@ func TestWriteLiteralList(t *testing.T) {
name: "one traversal literal, one string literal",
literals: []*terraformWriter.Literal{
{
Tokens: []string{"type", "name", "prop"},
String: "type.name.prop",
},
{
Value: "foobar",
String: "\"foobar\"",
},
},
expected: `foo = [type.name.prop, "foobar"]`,

93
upup/pkg/fi/cloudup/terraformWriter/literal.go
View File

@ -21,39 +21,23 @@ import (
"fmt"
"sort"
"strings"
"k8s.io/klog/v2"
)
// Literal represents a literal in terraform syntax
type Literal struct {
// String is the Terraform representation.
String string `cty:"string"`
// Value is used to support Terraform's "${}" interpolation.
Value string `cty:"value"`
// Index to support the index of the count meta-argument.
Index bool `cty:"index"`
// Tokens are portions of a literal reference joined by periods.
// example: {"aws_vpc", "foo", "id"}
Tokens []string `cty:"tokens"`
// FnArgs contains string representations of arguments to the function call.
// Any string arguments must be quoted.
FnArgs []string `cty:"fn_arg"`
}
var _ json.Marshaler = &Literal{}
func (l *Literal) MarshalJSON() ([]byte, error) {
return json.Marshal(&l.Value)
return json.Marshal(&l.String)
}
func LiteralFunctionExpression(functionName string, args ...string) *Literal {
return &Literal{
String: fmt.Sprintf("%v(%v)", functionName, strings.Join(args, ", ")),
Value: fmt.Sprintf("${%v(%v)}", functionName, strings.Join(args, ", ")),
FnArgs: args,
}
}
@ -63,81 +47,41 @@ func LiteralSelfLink(resourceType, resourceName string) *Literal {
func LiteralData(dataSourceType, dataSourceName, prop string) *Literal {
tfName := sanitizeName(dataSourceName)
expr := "${data." + dataSourceType + "." + tfName + "." + prop + "}"
return &Literal{
Value: expr,
Tokens: []string{"data", dataSourceType, tfName, prop},
String: "data." + dataSourceType + "." + tfName + "." + prop + "",
}
}
func LiteralProperty(resourceType, resourceName, prop string) *Literal {
tfName := sanitizeName(resourceName)
expr := "${" + resourceType + "." + tfName + "." + prop + "}"
return &Literal{
Value: expr,
Tokens: []string{resourceType, tfName, prop},
String: resourceType + "." + tfName + "." + prop,
}
}
func LiteralTokens(tokens ...string) *Literal {
expr := "${" + strings.Join(tokens, ".") + "}"
return &Literal{
Value: expr,
Tokens: tokens,
String: strings.Join(tokens, "."),
}
}
func LiteralFromStringValue(s string) *Literal {
return &Literal{Value: s}
return &Literal{
String: "\"" + s + "\"",
}
}
func LiteralWithIndex(s string) *Literal {
return &Literal{Value: s, Index: true}
return &Literal{
String: fmt.Sprintf("\"%s-${count.index}\"", s),
}
type literalWithJSON struct {
literal *Literal
key string
}
type byKey []*literalWithJSON
func (a byKey) Len() int { return len(a) }
func (a byKey) Swap(i, j int) { a[i], a[j] = a[j], a[i] }
func (a byKey) Less(i, j int) bool {
return a[i].key < a[j].key
}
// buildSortProxies maps a list of Literals to a list of literalWithJSON
func buildSortProxies(v []*Literal) ([]*literalWithJSON, error) {
var proxies []*literalWithJSON
for _, l := range v {
k, err := json.Marshal(l)
if err != nil {
return nil, err
}
proxies = append(proxies, &literalWithJSON{
literal: l,
key: string(k),
})
}
return proxies, nil
}
// SortLiterals sorts a list of Literal, by key. It does so in-place
func SortLiterals(v []*Literal) {
proxies, err := buildSortProxies(v)
if err != nil {
// Very unexpected
klog.Fatalf("error processing terraform Literal: %v", err)
}
sort.Sort(byKey(proxies))
for i := range proxies {
v[i] = proxies[i].literal
}
sort.Slice(v, func(i, j int) bool {
return v[i].String < v[j].String
})
}
// dedupLiterals removes any duplicate Literals before returning the slice.
@ -147,19 +91,14 @@ func dedupLiterals(v []*Literal) ([]*Literal, error) {
return nil, nil
}
proxies, err := buildSortProxies(v)
if err != nil {
return nil, err
}
sort.Sort(byKey(proxies))
SortLiterals(v)
var deduped []*Literal
for i, p := range proxies {
if i != 0 && proxies[i-1].key == proxies[i].key {
for i, p := range v {
if i != 0 && v[i-1].String == v[i].String {
continue
}
deduped = append(deduped, p.literal)
deduped = append(deduped, p)
}
return deduped, nil

21
upup/pkg/fi/cloudup/terraformWriter/writer.go
View File

@ -75,6 +75,20 @@ func (t *TerraformWriter) InitTerraformWriter() {
}
func (t *TerraformWriter) AddFileBytes(resourceType string, resourceName string, key string, data []byte, base64 bool) (*Literal, error) {
path, err := t.AddFilePath(resourceType, resourceName, key, data, base64)
if err != nil {
return nil, err
}
fn := "file"
if base64 {
fn = "filebase64"
}
return LiteralFunctionExpression(fn, path.String), nil
}
func (t *TerraformWriter) AddFilePath(resourceType string, resourceName string, key string, data []byte, base64 bool) (*Literal, error) {
id := resourceType + "_" + resourceName + "_" + key
t.mutex.Lock()
@ -84,11 +98,8 @@ func (t *TerraformWriter) AddFileBytes(resourceType string, resourceName string,
t.Files[p] = data
modulePath := fmt.Sprintf("%q", path.Join("${path.module}", p))
fn := "file"
if base64 {
fn = "filebase64"
}
return LiteralFunctionExpression(fn, modulePath), nil
return LiteralTokens(modulePath), nil
}
func (t *TerraformWriter) RenderDataSource(dataType string, dataName string, e interface{}) error {

6
util/pkg/vfs/gsfs.go
View File

@ -389,7 +389,7 @@ func (p *GSPath) Hash(a hashing.HashAlgorithm) (*hashing.Hash, error) {
type terraformGSObject struct {
Bucket string `json:"bucket" cty:"bucket"`
Name string `json:"name" cty:"name"`
Source string `json:"source" cty:"source"`
Source *terraformWriter.Literal `json:"source" cty:"source"`
Provider *terraformWriter.Literal `json:"provider,omitempty" cty:"provider"`
}
@ -406,7 +406,7 @@ func (p *GSPath) RenderTerraform(w *terraformWriter.TerraformWriter, name string
return fmt.Errorf("reading data: %v", err)
}
content, err := w.AddFileBytes("google_storage_bucket_object", name, "content", bytes, false)
content, err := w.AddFilePath("google_storage_bucket_object", name, "content", bytes, false)
if err != nil {
return fmt.Errorf("rendering GCS file: %v", err)
}
@ -414,7 +414,7 @@ func (p *GSPath) RenderTerraform(w *terraformWriter.TerraformWriter, name string
tf := &terraformGSObject{
Bucket: p.Bucket(),
Name: p.Object(),
Source: content.FnArgs[0],
Source: content,
Provider: terraformWriter.LiteralTokens("google", "files"),
}
err = w.RenderResource("google_storage_bucket_object", name, tf)

6
util/pkg/vfs/tests/gsfs_test.go
View File

@ -56,15 +56,15 @@ func TestGSRenderTerraform(t *testing.T) {
{
"bucket": "foo",
"name": "bar",
"provider": "${google.files}",
"provider": "google.files",
"source": "\"${path.module}/data/google_storage_bucket_object_bar_content\""
}
`,
expectedACLJSON: `
{
"bucket": "foo",
"object": "${google_storage_bucket_object.bar.output_name}",
"provider": "${google.files}",
"object": "google_storage_bucket_object.bar.output_name",
"provider": "google.files",
"role_entity": [
"READER:user-foo-123@project.iam.gserviceaccount.com"
]

4
util/pkg/vfs/tests/s3fs_test.go
View File

@ -43,9 +43,9 @@ func TestS3RenderTerraform(t *testing.T) {
{
"acl": "bucket-owner-full-control",
"bucket": "foo",
"content": "${file(\"${path.module}/data/aws_s3_object_bar_content\")}",
"content": "file(\"${path.module}/data/aws_s3_object_bar_content\")",
"key": "bar",
"provider": "${aws.files}",
"provider": "aws.files",
"server_side_encryption": "AES256"
}
`,