fix: resolve symlink during copy for helm package (#278)

* resolve symlink during copy for helm package

symlinks inside the chart folder would be copied to the new directory
for package. If those symlinks are relative, they wouldn't resolve
  anymore in the new location.

Calling cp with `-L` should resolve the symlinks before copying.

* add test

helm-git-plugin.sh

@@ -178,7 +178,7 @@ helm_package() {
   helm_args=${helm_args:-}
 
   tmp_target="$(mktemp -d "$TMPDIR/helm-git.XXXXXX")"
-  cp -r "$_source_path" "$tmp_target/$_chart_name"
+  cp -rL "$_source_path" "$tmp_target/$_chart_name"
   _source_path="$tmp_target/$_chart_name"
   cd "$_target_path" >&2
 

tests/02-helm.bats

@@ -3,7 +3,7 @@
 load 'test-helper'
 
 # helm_init(helm_home)
-@test "helm_init proprely initialize helm2" {
+@test "helm_init properly initialize helm2" {
     helm_v2 || skip
     run helm_init "$HELM_HOME"
     [ $status = 0 ]
@@ -14,7 +14,7 @@ load 'test-helper'
 }
 
 # helm_package(target_path, source_path, chart_name)
-@test "helm_package proprely package example-chart" {
+@test "helm_package properly package example-chart" {
     source_path="$BATS_TEST_DIRNAME/fixtures/example-chart"
     helm_v2 && helm_args="--home=$HELM_HOME"
     run helm_package "$HELM_GIT_OUTPUT" "$source_path" "example-chart"
@@ -23,6 +23,19 @@ load 'test-helper'
     [ $status = 0 ]
 }
 
+# helm_package(target_path, source_path, chart_name)
+@test "helm_package properly package example-chart-symlink" {
+    source_path="$BATS_TEST_DIRNAME/fixtures/example-chart-symlink/chart"
+    helm_v2 && helm_args="--home=$HELM_HOME"
+    run helm_package "$HELM_GIT_OUTPUT" "$source_path" "example-chart-symlink"
+    [ $status = 0 ]
+    run stat "$HELM_GIT_OUTPUT/example-chart-symlink-0.1.0.tgz"
+    [ $status = 0 ]
+    run tar --strip-components=2 -C $HELM_GIT_OUTPUT -xf "$HELM_GIT_OUTPUT/example-chart-symlink-0.1.0.tgz" example-chart-symlink/crds/test.yaml
+    [ $status = 0 ]
+    run diff $source_path/crds/test.yaml $HELM_GIT_OUTPUT/test.yaml
+}
+
 # helm_package(target_path, source_path, chart_name)
 @test "helm_package fails with incorrect chart" {
     source_path="$BATS_TEST_DIRNAME/fixtures/existing-dir"

tests/fixtures/example-chart-symlink/.helmignore

@@ -0,0 +1,22 @@
+# Patterns to ignore when building packages.
+# This supports shell glob matching, relative path matching, and
+# negation (prefixed with !). Only one pattern per line.
+.DS_Store
+# Common VCS dirs
+.git/
+.gitignore
+.bzr/
+.bzrignore
+.hg/
+.hgignore
+.svn/
+# Common backup files
+*.swp
+*.bak
+*.tmp
+*~
+# Various IDEs
+.project
+.idea/
+*.tmproj
+.vscode/

tests/fixtures/example-chart-symlink/chart/Chart.yaml

@@ -0,0 +1,5 @@
+apiVersion: v1
+appVersion: "1.0"
+description: A Helm chart for Kubernetes
+name: example-chart-symlink
+version: 0.1.0

tests/fixtures/example-chart-symlink/chart/crds

@@ -0,0 +1 @@
+../crds

tests/fixtures/example-chart-symlink/chart/extra-values.yaml

@@ -0,0 +1 @@
+replicaCount: 999

tests/fixtures/example-chart-symlink/chart/templates/NOTES.txt

@@ -0,0 +1,21 @@
+1. Get the application URL by running these commands:
+{{- if .Values.ingress.enabled }}
+{{- range $host := .Values.ingress.hosts }}
+  {{- range $.Values.ingress.paths }}
+  http{{ if $.Values.ingress.tls }}s{{ end }}://{{ $host }}{{ . }}
+  {{- end }}
+{{- end }}
+{{- else if contains "NodePort" .Values.service.type }}
+  export NODE_PORT=$(kubectl get --namespace {{ .Release.Namespace }} -o jsonpath="{.spec.ports[0].nodePort}" services {{ include "example-chart.fullname" . }})
+  export NODE_IP=$(kubectl get nodes --namespace {{ .Release.Namespace }} -o jsonpath="{.items[0].status.addresses[0].address}")
+  echo http://$NODE_IP:$NODE_PORT
+{{- else if contains "LoadBalancer" .Values.service.type }}
+    NOTE: It may take a few minutes for the LoadBalancer IP to be available.
+          You can watch the status of by running 'kubectl get svc -w {{ include "example-chart.fullname" . }}'
+  export SERVICE_IP=$(kubectl get svc --namespace {{ .Release.Namespace }} {{ include "example-chart.fullname" . }} -o jsonpath='{.status.loadBalancer.ingress[0].ip}')
+  echo http://$SERVICE_IP:{{ .Values.service.port }}
+{{- else if contains "ClusterIP" .Values.service.type }}
+  export POD_NAME=$(kubectl get pods --namespace {{ .Release.Namespace }} -l "app.kubernetes.io/name={{ include "example-chart.name" . }},app.kubernetes.io/instance={{ .Release.Name }}" -o jsonpath="{.items[0].metadata.name}")
+  echo "Visit http://127.0.0.1:8080 to use your application"
+  kubectl port-forward $POD_NAME 8080:80
+{{- end }}

tests/fixtures/example-chart-symlink/chart/templates/_helpers.tpl

@@ -0,0 +1,32 @@
+{{/* vim: set filetype=mustache: */}}
+{{/*
+Expand the name of the chart.
+*/}}
+{{- define "example-chart.name" -}}
+{{- default .Chart.Name .Values.nameOverride | trunc 63 | trimSuffix "-" -}}
+{{- end -}}
+
+{{/*
+Create a default fully qualified app name.
+We truncate at 63 chars because some Kubernetes name fields are limited to this (by the DNS naming spec).
+If release name contains chart name it will be used as a full name.
+*/}}
+{{- define "example-chart.fullname" -}}
+{{- if .Values.fullnameOverride -}}
+{{- .Values.fullnameOverride | trunc 63 | trimSuffix "-" -}}
+{{- else -}}
+{{- $name := default .Chart.Name .Values.nameOverride -}}
+{{- if contains $name .Release.Name -}}
+{{- .Release.Name | trunc 63 | trimSuffix "-" -}}
+{{- else -}}
+{{- printf "%s-%s" .Release.Name $name | trunc 63 | trimSuffix "-" -}}
+{{- end -}}
+{{- end -}}
+{{- end -}}
+
+{{/*
+Create chart name and version as used by the chart label.
+*/}}
+{{- define "example-chart.chart" -}}
+{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" -}}
+{{- end -}}

tests/fixtures/example-chart-symlink/chart/templates/deployment.yaml

@@ -0,0 +1,51 @@
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: {{ include "example-chart.fullname" . }}
+  labels:
+    app.kubernetes.io/name: {{ include "example-chart.name" . }}
+    helm.sh/chart: {{ include "example-chart.chart" . }}
+    app.kubernetes.io/instance: {{ .Release.Name }}
+    app.kubernetes.io/managed-by: {{ .Release.Service }}
+spec:
+  replicas: {{ .Values.replicaCount }}
+  selector:
+    matchLabels:
+      app.kubernetes.io/name: {{ include "example-chart.name" . }}
+      app.kubernetes.io/instance: {{ .Release.Name }}
+  template:
+    metadata:
+      labels:
+        app.kubernetes.io/name: {{ include "example-chart.name" . }}
+        app.kubernetes.io/instance: {{ .Release.Name }}
+    spec:
+      containers:
+        - name: {{ .Chart.Name }}
+          image: "{{ .Values.image.repository }}:{{ .Values.image.tag }}"
+          imagePullPolicy: {{ .Values.image.pullPolicy }}
+          ports:
+            - name: http
+              containerPort: 80
+              protocol: TCP
+          livenessProbe:
+            httpGet:
+              path: /
+              port: http
+          readinessProbe:
+            httpGet:
+              path: /
+              port: http
+          resources:
+            {{- toYaml .Values.resources | nindent 12 }}
+      {{- with .Values.nodeSelector }}
+      nodeSelector:
+        {{- toYaml . | nindent 8 }}
+      {{- end }}
+    {{- with .Values.affinity }}
+      affinity:
+        {{- toYaml . | nindent 8 }}
+    {{- end }}
+    {{- with .Values.tolerations }}
+      tolerations:
+        {{- toYaml . | nindent 8 }}
+    {{- end }}

tests/fixtures/example-chart-symlink/chart/templates/ingress.yaml

@@ -0,0 +1,40 @@
+{{- if .Values.ingress.enabled -}}
+{{- $fullName := include "example-chart.fullname" . -}}
+{{- $ingressPaths := .Values.ingress.paths -}}
+apiVersion: extensions/v1beta1
+kind: Ingress
+metadata:
+  name: {{ $fullName }}
+  labels:
+    app.kubernetes.io/name: {{ include "example-chart.name" . }}
+    helm.sh/chart: {{ include "example-chart.chart" . }}
+    app.kubernetes.io/instance: {{ .Release.Name }}
+    app.kubernetes.io/managed-by: {{ .Release.Service }}
+  {{- with .Values.ingress.annotations }}
+  annotations:
+    {{- toYaml . | nindent 4 }}
+  {{- end }}
+spec:
+{{- if .Values.ingress.tls }}
+  tls:
+  {{- range .Values.ingress.tls }}
+    - hosts:
+      {{- range .hosts }}
+        - {{ . | quote }}
+      {{- end }}
+      secretName: {{ .secretName }}
+  {{- end }}
+{{- end }}
+  rules:
+  {{- range .Values.ingress.hosts }}
+    - host: {{ . | quote }}
+      http:
+        paths:
+  {{- range $ingressPaths }}
+          - path: {{ . }}
+            backend:
+              serviceName: {{ $fullName }}
+              servicePort: http
+  {{- end }}
+  {{- end }}
+{{- end }}

tests/fixtures/example-chart-symlink/chart/templates/service.yaml

@@ -0,0 +1,19 @@
+apiVersion: v1
+kind: Service
+metadata:
+  name: {{ include "example-chart.fullname" . }}
+  labels:
+    app.kubernetes.io/name: {{ include "example-chart.name" . }}
+    helm.sh/chart: {{ include "example-chart.chart" . }}
+    app.kubernetes.io/instance: {{ .Release.Name }}
+    app.kubernetes.io/managed-by: {{ .Release.Service }}
+spec:
+  type: {{ .Values.service.type }}
+  ports:
+    - port: {{ .Values.service.port }}
+      targetPort: http
+      protocol: TCP
+      name: http
+  selector:
+    app.kubernetes.io/name: {{ include "example-chart.name" . }}
+    app.kubernetes.io/instance: {{ .Release.Name }}

tests/fixtures/example-chart-symlink/chart/templates/tests/test-connection.yaml

@@ -0,0 +1,18 @@
+apiVersion: v1
+kind: Pod
+metadata:
+  name: "{{ include "example-chart.fullname" . }}-test-connection"
+  labels:
+    app.kubernetes.io/name: {{ include "example-chart.name" . }}
+    helm.sh/chart: {{ include "example-chart.chart" . }}
+    app.kubernetes.io/instance: {{ .Release.Name }}
+    app.kubernetes.io/managed-by: {{ .Release.Service }}
+  annotations:
+    "helm.sh/hook": test-success
+spec:
+  containers:
+    - name: wget
+      image: busybox
+      command: ['wget']
+      args:  ['{{ include "example-chart.fullname" . }}:{{ .Values.service.port }}']
+  restartPolicy: Never

tests/fixtures/example-chart-symlink/chart/values.yaml

@@ -0,0 +1,48 @@
+# Default values for example-chart.
+# This is a YAML-formatted file.
+# Declare variables to be passed into your templates.
+
+replicaCount: 1
+
+image:
+  repository: nginx
+  tag: stable
+  pullPolicy: IfNotPresent
+
+nameOverride: ""
+fullnameOverride: ""
+
+service:
+  type: ClusterIP
+  port: 80
+
+ingress:
+  enabled: false
+  annotations: {}
+    # kubernetes.io/ingress.class: nginx
+    # kubernetes.io/tls-acme: "true"
+  paths: []
+  hosts:
+    - chart-example.local
+  tls: []
+  #  - secretName: chart-example-tls
+  #    hosts:
+  #      - chart-example.local
+
+resources: {}
+  # We usually recommend not to specify default resources and to leave this as a conscious
+  # choice for the user. This also increases chances charts run on environments with little
+  # resources, such as Minikube. If you do want to specify resources, uncomment the following
+  # lines, adjust them as necessary, and remove the curly braces after 'resources:'.
+  # limits:
+  #  cpu: 100m
+  #  memory: 128Mi
+  # requests:
+  #  cpu: 100m
+  #  memory: 128Mi
+
+nodeSelector: {}
+
+tolerations: []
+
+affinity: {}

tests/fixtures/example-chart-symlink/crds/test.yaml

@@ -0,0 +1 @@
+test