Merge pull request #422 from UffizziCloud/feature/1320-fix-env-vars-with-dollar-sign-2

[#1320] fixed env vars with dollar sign in the value

Author: moklidia

.github/workflows/code-quality.yml

@@ -27,13 +27,13 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: 3.0.2
           bundler-cache: false
       - name: Build Image
-        uses: docker/build-push-action@v2
+        uses: docker/build-push-action@v5
         with:
           tags: uffizzi/cli:test-install
           platforms: linux/amd64

.github/workflows/docker-image-release.yml

@@ -8,24 +8,25 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
       - name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v1
+        uses: docker/setup-buildx-action@v2
       - name: Login to DockerHub
-        uses: docker/login-action@v1
+        uses: docker/login-action@v2
         with:
           username: ${{ secrets.DOCKERHUB_USERNAME }}
           password: ${{ secrets.DOCKERHUB_TOKEN }}
       - name: Docker meta
         id: meta
-        uses: docker/metadata-action@v4
+        uses: docker/metadata-action@v5
         with:
           images: uffizzi/cli
           tags: |
             type=semver,pattern=v{{version}}
             type=semver,pattern=v{{major}}
       - name: Build and push
-        uses: docker/build-push-action@v2
+        uses: docker/build-push-action@v5
         with:
+          platforms: linux/amd64,linux/arm64
           push: true
           tags: ${{ steps.meta.outputs.tags }}

.github/workflows/gem-release.yml

@@ -8,7 +8,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
       - name: Release Ruby Gem
         run: make release_gem
         env:

Dockerfile

@@ -1,3 +1,4 @@
+# Builder stage
 FROM ruby:3.0.3-alpine AS builder
 
 RUN apk --update add --no-cache \
@@ -29,13 +30,11 @@ COPY . .
 
 RUN bundle exec rake install
 
-# M-M-M-M-MULTISTAGE!!!
-FROM ruby:3.0.3 AS shell
+FROM ruby:3.0.3-alpine AS shell
 
-RUN apt-get update && apt-get install -y \
-    vim \
+RUN apk --update add --no-cache \
     bash \
-    && rm -rf /var/lib/apt/lists/*
+    vim
 
 WORKDIR /root/
 

lib/uffizzi/services/env_variables_service.rb

@@ -7,7 +7,7 @@
 class EnvVariablesService
   class << self
     def substitute_env_variables(compose_file_data)
-      compose_file_data.gsub(/\${1,2}\{?([?:\-_A-Za-z0-9]+)\}?/) do |variable|
+      compose_file_data.gsub(/(?<![^ \t\n])\${1,2}\{?([?:\-_A-Za-z0-9]+)\}?/) do |variable|
         next variable if variable.start_with?('$$')
 
         variable_content = variable.match(/[?:\-_A-Za-z0-9]+/).to_s

test/compose_files/test_compose_with_env_vars_with_dollar_sign.yml

@@ -0,0 +1,15 @@
+services:
+  hello-world:
+    image: ${IMAGE:-nginx}
+    environment:
+      KEY: 'lkjlkjk@^$lkjj'
+
+configs:
+  vote_conf:
+    file: ./vote.conf
+  defaulf_conf:
+    file: config_files/config_file.conf
+
+x-uffizzi-ingress:
+  service: hello-world
+  port: $PORT

test/uffizzi/cli/preview_test.rb

@@ -426,7 +426,6 @@ def test_preview_create_with_env_vars_failed
     stubbed_uffizzi_preview_create = stub_uffizzi_preview_create_success(create_body, @project_slug)
     ENV['IMAGE'] = 'nginx'
     ENV['CONFIG_SOURCE'] = 'vote.conf'
-
     error = assert_raises(Uffizzi::Error) do
       @preview.create('test/compose_files/test_compose_with_env_vars.yml')
     end
@@ -683,4 +682,23 @@ def test_create_preview_with_failed_deployment
                    " finished_at: #{k8s_container_last_state[:finished_at]}\n"
     assert_equal(render_server_error(expected_msg), error.message)
   end
+
+  def test_preview_update_with_env_var_containing_dollar_sign_success
+    update_body = json_fixture('files/uffizzi/uffizzi_preview_create_success.json')
+    activity_items_body = json_fixture('files/uffizzi/uffizzi_preview_activity_items_deployed.json')
+    deployment_id = update_body[:deployment][:id]
+    stubbed_uffizzi_preview_update = stub_uffizzi_preview_update_success(update_body, @project_slug, deployment_id)
+    stubbed_uffizzi_preview_deploy_containers = stub_uffizzi_preview_deploy_containers_success(@project_slug, deployment_id)
+    stubbed_uffizzi_preview_activity_items = stub_uffizzi_preview_activity_items_success(activity_items_body, @project_slug, deployment_id)
+    ENV['PORT'] = '80'
+
+    @preview.update("deployment-#{deployment_id}", 'test/compose_files/test_compose_with_env_vars_with_dollar_sign.yml')
+
+    *_, url_message, proxy_url_message = Uffizzi.ui.messages
+    assert_equal("Deployment url: https://#{update_body[:deployment][:preview_url]}", url_message)
+    assert_equal("Deployment proxy url: https://#{update_body[:deployment][:proxy_preview_url]}", proxy_url_message)
+    assert_requested(stubbed_uffizzi_preview_activity_items, times: 2)
+    assert_requested(stubbed_uffizzi_preview_deploy_containers)
+    assert_requested(stubbed_uffizzi_preview_update)
+  end
 end