Skip to content
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.

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

r/pod: Fix a crash caused by wrong field name (config map volume source) #19

Merged
merged 2 commits into from
Jul 5, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
84 changes: 79 additions & 5 deletions kubernetes/resource_kubernetes_pod_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -268,6 +268,38 @@ func TestAccKubernetesPod_with_volume_mount(t *testing.T) {
})
}

func TestAccKubernetesPod_with_cfg_map_volume_mount(t *testing.T) {
var conf api.Pod

podName := fmt.Sprintf("tf-acc-test-%s", acctest.RandStringFromCharSet(10, acctest.CharSetAlphaNum))
cfgMap := fmt.Sprintf("tf-acc-test-%s", acctest.RandStringFromCharSet(10, acctest.CharSetAlphaNum))

imageName := "nginx:1.7.9"

resource.Test(t, resource.TestCase{
PreCheck: func() { testAccPreCheck(t) },
Providers: testAccProviders,
CheckDestroy: testAccCheckKubernetesPodDestroy,
Steps: []resource.TestStep{
{
Config: testAccKubernetesPodConfigWithConfigMapVolume(cfgMap, podName, imageName),
Check: resource.ComposeAggregateTestCheckFunc(
testAccCheckKubernetesPodExists("kubernetes_pod.test", &conf),
resource.TestCheckResourceAttr("kubernetes_pod.test", "spec.0.container.0.image", imageName),
resource.TestCheckResourceAttr("kubernetes_pod.test", "spec.0.container.0.volume_mount.#", "1"),
resource.TestCheckResourceAttr("kubernetes_pod.test", "spec.0.container.0.volume_mount.0.mount_path", "/tmp/my_path"),
resource.TestCheckResourceAttr("kubernetes_pod.test", "spec.0.container.0.volume_mount.0.name", "cfg"),
resource.TestCheckResourceAttr("kubernetes_pod.test", "spec.0.container.0.volume_mount.0.read_only", "false"),
resource.TestCheckResourceAttr("kubernetes_pod.test", "spec.0.container.0.volume_mount.0.sub_path", ""),
resource.TestCheckResourceAttr("kubernetes_pod.test", "spec.0.volume.0.name", "cfg"),
resource.TestCheckResourceAttr("kubernetes_pod.test", "spec.0.volume.0.config_map.0.name", cfgMap),
resource.TestCheckResourceAttr("kubernetes_pod.test", "spec.0.volume.0.config_map.0.default_mode", "511"), // 0777 in decimal
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

as discussed on Slack, I could see this causing confusion - would it be worth making this a type String instead until we've better options?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As discussed on Slack - I generally agree that this is confusing.

I’m just not sure it’s worth implementing a dirty solution (TypeString) which may require state migration + config change once we implement the right solution.

I’ll take a look into the schema internals and see how hard it would be to implement IntRepresentation into the schema. Then if we do it would be just a matter of adding a single line to the existing schema, which seems much cleaner.

),
},
},
})
}

func TestAccKubernetesPod_with_resource_requirements(t *testing.T) {
var conf api.Pod

Expand Down Expand Up @@ -642,14 +674,14 @@ resource "kubernetes_pod" "test" {
container {
image = "%s"
name = "containername"
volume_mount {
mount_path = "/tmp/my_path"
name = "db"
}
volume_mount {
mount_path = "/tmp/my_path"
name = "db"
}
}
volume {
name = "db"
secret = {
secret {
secret_name = "${kubernetes_secret.test.metadata.0.name}"
}
}
Expand All @@ -658,6 +690,48 @@ resource "kubernetes_pod" "test" {
`, secretName, podName, imageName)
}

func testAccKubernetesPodConfigWithConfigMapVolume(secretName, podName, imageName string) string {
return fmt.Sprintf(`
resource "kubernetes_config_map" "test" {
metadata {
name = "%s"
}

data {
one = "first"
}
}

resource "kubernetes_pod" "test" {
metadata {
labels {
app = "pod_label"
}

name = "%s"
}

spec {
container {
image = "%s"
name = "containername"
volume_mount {
mount_path = "/tmp/my_path"
name = "cfg"
}
}
volume {
name = "cfg"
config_map {
name = "${kubernetes_config_map.test.metadata.0.name}"
default_mode = 0777
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

might be worth adding some validation to this to the schema too?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agreed, I'll add validation.

}
}
}
}
`, secretName, podName, imageName)
}

func testAccKubernetesPodConfigWithResourceRequirements(podName, imageName string) string {
return fmt.Sprintf(`

Expand Down
7 changes: 4 additions & 3 deletions kubernetes/schema_pod_spec.go
Original file line number Diff line number Diff line change
Expand Up @@ -188,9 +188,10 @@ func volumeSchema() *schema.Resource {
},
},
"default_mode": {
Type: schema.TypeInt,
Description: "Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.",
Optional: true,
Type: schema.TypeInt,
Description: "Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.",
Optional: true,
ValidateFunc: validateModeBits,
},
"name": {
Type: schema.TypeString,
Expand Down
4 changes: 2 additions & 2 deletions kubernetes/structures_pod.go
Original file line number Diff line number Diff line change
Expand Up @@ -473,7 +473,7 @@ func expandConfigMapVolumeSource(l []interface{}) *v1.ConfigMapVolumeSource {
}
in := l[0].(map[string]interface{})
obj := &v1.ConfigMapVolumeSource{
DefaultMode: ptrToInt32(int32(in["default_mode "].(int))),
DefaultMode: ptrToInt32(int32(in["default_mode"].(int))),
}

if v, ok := in["name"].(string); ok {
Expand All @@ -493,7 +493,7 @@ func expandDownwardAPIVolumeSource(l []interface{}) (*v1.DownwardAPIVolumeSource
}
in := l[0].(map[string]interface{})
obj := &v1.DownwardAPIVolumeSource{
DefaultMode: ptrToInt32(int32(in["default_mode "].(int))),
DefaultMode: ptrToInt32(int32(in["default_mode"].(int))),
}
if v, ok := in["items"].([]interface{}); ok && len(v) > 0 {
var err error
Expand Down
8 changes: 8 additions & 0 deletions kubernetes/validators.go
Original file line number Diff line number Diff line change
Expand Up @@ -165,6 +165,14 @@ func validateTerminationGracePeriodSeconds(value interface{}, key string) (ws []
return
}

func validateModeBits(value interface{}, key string) (ws []string, es []error) {
v := value.(int)
if v < 0 || v > 0777 {
es = append(es, fmt.Errorf("%s (%#o) expects octal notation (a value between 0 and 0777)", key, v))
}
return
}

func validateAttributeValueDoesNotContain(searchString string) schema.SchemaValidateFunc {
return func(v interface{}, k string) (ws []string, errors []error) {
input := v.(string)
Expand Down
27 changes: 27 additions & 0 deletions kubernetes/validators_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
package kubernetes

import (
"testing"
)

func TestValidateModeBits(t *testing.T) {
validCases := []int{
0, 0001, 0644, 0777,
}
for _, mode := range validCases {
_, es := validateModeBits(mode, "mode")
if len(es) > 0 {
t.Fatalf("Expected %#o to be valid: %#v", mode, es)
}
}

invalidCases := []int{
-5, -1, 512, 777,
}
for _, mode := range invalidCases {
_, es := validateModeBits(mode, "mode")
if len(es) == 0 {
t.Fatalf("Expected %#o to be invalid", mode)
}
}
}