Merge pull request #310 from cybozu-go/yaml-placeholders

test: replace %s to "%s"

Author: satoru-takeuchi

Makefile

@@ -104,10 +104,17 @@ golangci-lint:
 	}
 
 .PHONY: lint
-lint: golangci-lint ## Run golangci-lint linter & yamllint
+lint: golangci-lint check-yaml-template ## Run golangci-lint linter & yamllint
 	$(GOLANGCI_LINT) run --timeout 3m
 	$(GOLANGCI_LINT) run -c .golangci-new.yml --timeout 3m internal/controller/domain internal/controller/usecase
 
+.PHONY: check-yaml-template
+check-yaml-template: ## Ensure go-template placeholders in YAML are quoted (use "%s" instead of bare %s).
+	@if grep -rnP '(?<!")%s|%s(?!")' --include='*.yaml' --include='*.yml' .; then \
+		echo 'ERROR: found bare "%s" in the YAML files above; quote them as "%s" so YAML validators accept them.'; \
+		exit 1; \
+	fi
+
 .PHONY: lint-fix
 lint-fix: golangci-lint ## Run golangci-lint linter and perform fixes
 	$(GOLANGCI_LINT) run --fix

test/e2e/multik8s/testutil/testdata/mantlebackup-template.yaml

@@ -3,12 +3,12 @@ kind: MantleBackup
 metadata:
   labels:
     app.kubernetes.io/name: mantlebackup
-    app.kubernetes.io/instance: %s
+    app.kubernetes.io/instance: "%s"
     app.kubernetes.io/part-of: mantle
     app.kubernetes.io/managed-by: kustomize
     app.kubernetes.io/created-by: mantle
-  name: %s
-  namespace: %s
+  name: "%s"
+  namespace: "%s"
 spec:
-  pvc: %s
+  pvc: "%s"
   expire: "1d"

test/e2e/multik8s/testutil/testdata/mantlebackupconfig-template.yaml

@@ -1,10 +1,10 @@
 apiVersion: mantle.cybozu.io/v1
 kind: MantleBackupConfig
 metadata:
-  name: %s
-  namespace: %s
+  name: "%s"
+  namespace: "%s"
 spec:
-  pvc: %s
+  pvc: "%s"
   expire: "1d"
   schedule: "00 00 * * *"
   suspend: false

test/e2e/multik8s/testutil/testdata/mantlerestore-template.yaml

@@ -3,11 +3,11 @@ kind: MantleRestore
 metadata:
   labels:
     app.kubernetes.io/name: mantlerestore
-    app.kubernetes.io/instance: %s
+    app.kubernetes.io/instance: "%s"
     app.kubernetes.io/part-of: mantle
     app.kubernetes.io/managed-by: kustomize
     app.kubernetes.io/created-by: mantle
-  name: %s
-  namespace: %s
+  name: "%s"
+  namespace: "%s"
 spec:
-  backup: %s
+  backup: "%s"

test/e2e/multik8s/testutil/testdata/mount-deploy-template.yaml

@@ -1,17 +1,17 @@
 apiVersion: apps/v1
 kind: Deployment
 metadata:
-  name: %s
-  namespace: %s
+  name: "%s"
+  namespace: "%s"
 spec:
   selector:
     matchLabels:
-      app: %s
+      app: "%s"
   replicas: 1
   template:
     metadata:
       labels:
-        app: %s
+        app: "%s"
     spec:
       securityContext:
         runAsUser: 10000
@@ -30,4 +30,4 @@ spec:
       volumes:
         - name: volume
           persistentVolumeClaim:
-            claimName: %s
+            claimName: "%s"

test/e2e/multik8s/testutil/testdata/pvc-template.yaml

@@ -2,7 +2,7 @@
 apiVersion: v1
 kind: PersistentVolumeClaim
 metadata:
-  name: %s
+  name: "%s"
 spec:
   accessModes:
     - ReadWriteOnce

test/e2e/multik8s/testutil/testdata/rbd-pool-sc-template.yaml

@@ -2,7 +2,7 @@ apiVersion: ceph.rook.io/v1
 kind: CephBlockPool
 metadata:
   name: rook-ceph-block
-  namespace: %s
+  namespace: "%s"
 spec:
   failureDomain: osd
   replicated:
@@ -15,16 +15,16 @@ metadata:
   name: rook-ceph-block
 provisioner: rook-ceph.rbd.csi.ceph.com
 parameters:
-  clusterID: %s
+  clusterID: "%s"
   pool: rook-ceph-block
   imageFormat: "2"
   imageFeatures: layering
   csi.storage.k8s.io/provisioner-secret-name: rook-csi-rbd-provisioner
-  csi.storage.k8s.io/provisioner-secret-namespace: %s
+  csi.storage.k8s.io/provisioner-secret-namespace: "%s"
   csi.storage.k8s.io/controller-expand-secret-name: rook-csi-rbd-provisioner
-  csi.storage.k8s.io/controller-expand-secret-namespace: %s
+  csi.storage.k8s.io/controller-expand-secret-namespace: "%s"
   csi.storage.k8s.io/node-stage-secret-name: rook-csi-rbd-node
-  csi.storage.k8s.io/node-stage-secret-namespace: %s
+  csi.storage.k8s.io/node-stage-secret-namespace: "%s"
   csi.storage.k8s.io/fstype: ext4
 allowVolumeExpansion: true
 reclaimPolicy: Delete

test/e2e/multik8s/testutil/testdata/write-job-template.yaml

@@ -1,8 +1,8 @@
 apiVersion: batch/v1
 kind: Job
 metadata:
-  name: %s
-  namespace: %s
+  name: "%s"
+  namespace: "%s"
 spec:
   template:
     spec:
@@ -22,4 +22,4 @@ spec:
       volumes:
       - name: volume
         persistentVolumeClaim:
-          claimName: %s
+          claimName: "%s"

test/e2e/singlek8s/testdata/mantlebackup-template.yaml

@@ -3,12 +3,12 @@ kind: MantleBackup
 metadata:
   labels:
     app.kubernetes.io/name: mantlebackup
-    app.kubernetes.io/instance: %s
+    app.kubernetes.io/instance: "%s"
     app.kubernetes.io/part-of: mantle
     app.kubernetes.io/managed-by: kustomize
     app.kubernetes.io/created-by: mantle
-  name: %s
-  namespace: %s
+  name: "%s"
+  namespace: "%s"
 spec:
-  pvc: %s
+  pvc: "%s"
   expire: "1d"

test/e2e/singlek8s/testdata/mantlebackupconfig-template.yaml

@@ -1,10 +1,10 @@
 apiVersion: mantle.cybozu.io/v1
 kind: MantleBackupConfig
 metadata:
-  name: %s
-  namespace: %s
+  name: "%s"
+  namespace: "%s"
 spec:
-  pvc: %s
+  pvc: "%s"
   schedule: "0 0 * * *"
   expire: "2w"
   suspend: false