| # Licensed to the Apache Software Foundation (ASF) under one |
| # or more contributor license agreements. See the NOTICE file |
| # distributed with this work for additional information |
| # regarding copyright ownership. The ASF licenses this file |
| # to you under the Apache License, Version 2.0 (the |
| # "License"); you may not use this file except in compliance |
| # with the License. You may obtain a copy of the License at |
| # |
| # http://www.apache.org/licenses/LICENSE-2.0 |
| # |
| # Unless required by applicable law or agreed to in writing, |
| # software distributed under the License is distributed on an |
| # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| # KIND, either express or implied. See the License for the |
| # specific language governing permissions and limitations |
| # under the License. |
| |
| import unittest |
| |
| import jmespath |
| |
| from tests.charts.helm_template_generator import render_chart |
| |
| |
| class GitSyncSchedulerTest(unittest.TestCase): |
| def test_should_add_dags_volume(self): |
| docs = render_chart( |
| values={"dags": {"gitSync": {"enabled": True}}}, |
| show_only=["templates/scheduler/scheduler-deployment.yaml"], |
| ) |
| |
| # check that there is a volume and git-sync and scheduler container mount it |
| assert len(jmespath.search("spec.template.spec.volumes[?name=='dags']", docs[0])) > 0 |
| assert ( |
| len( |
| jmespath.search( |
| "(spec.template.spec.containers[?name=='scheduler'].volumeMounts[])[?name=='dags']", |
| docs[0], |
| ) |
| ) |
| > 0 |
| ) |
| assert ( |
| len( |
| jmespath.search( |
| "(spec.template.spec.containers[?name=='git-sync'].volumeMounts[])[?name=='dags']", |
| docs[0], |
| ) |
| ) |
| > 0 |
| ) |
| |
| def test_validate_the_git_sync_container_spec(self): |
| docs = render_chart( |
| values={ |
| "images": { |
| "gitSync": { |
| "repository": "test-registry/test-repo", |
| "tag": "test-tag", |
| "pullPolicy": "Always", |
| } |
| }, |
| "dags": { |
| "gitSync": { |
| "enabled": True, |
| "containerName": "git-sync-test", |
| "wait": 66, |
| "maxFailures": 70, |
| "subPath": "path1/path2", |
| "rev": "HEAD", |
| "depth": 1, |
| "repo": "https://github.com/apache/airflow.git", |
| "branch": "test-branch", |
| "sshKeySecret": None, |
| "credentialsSecret": None, |
| "knownHosts": None, |
| }, |
| "persistence": {"enabled": True}, |
| }, |
| }, |
| show_only=["templates/scheduler/scheduler-deployment.yaml"], |
| ) |
| |
| assert { |
| "name": "git-sync-test", |
| "securityContext": {"runAsUser": 65533}, |
| "image": "test-registry/test-repo:test-tag", |
| "imagePullPolicy": "Always", |
| "env": [ |
| {"name": "GIT_SYNC_REV", "value": "HEAD"}, |
| {"name": "GIT_SYNC_BRANCH", "value": "test-branch"}, |
| {"name": "GIT_SYNC_REPO", "value": "https://github.com/apache/airflow.git"}, |
| {"name": "GIT_SYNC_DEPTH", "value": "1"}, |
| {"name": "GIT_SYNC_ROOT", "value": "/git"}, |
| {"name": "GIT_SYNC_DEST", "value": "repo"}, |
| {"name": "GIT_SYNC_ADD_USER", "value": "true"}, |
| {"name": "GIT_SYNC_WAIT", "value": "66"}, |
| {"name": "GIT_SYNC_MAX_SYNC_FAILURES", "value": "70"}, |
| ], |
| "volumeMounts": [{"mountPath": "/git", "name": "dags"}], |
| "resources": {}, |
| } == jmespath.search("spec.template.spec.containers[1]", docs[0]) |
| |
| def test_validate_if_ssh_params_are_added(self): |
| docs = render_chart( |
| values={ |
| "dags": { |
| "gitSync": { |
| "enabled": True, |
| "containerName": "git-sync-test", |
| "sshKeySecret": "ssh-secret", |
| "knownHosts": None, |
| "branch": "test-branch", |
| } |
| } |
| }, |
| show_only=["templates/scheduler/scheduler-deployment.yaml"], |
| ) |
| |
| assert {"name": "GIT_SSH_KEY_FILE", "value": "/etc/git-secret/ssh"} in jmespath.search( |
| "spec.template.spec.containers[1].env", docs[0] |
| ) |
| assert {"name": "GIT_SYNC_SSH", "value": "true"} in jmespath.search( |
| "spec.template.spec.containers[1].env", docs[0] |
| ) |
| assert {"name": "GIT_KNOWN_HOSTS", "value": "false"} in jmespath.search( |
| "spec.template.spec.containers[1].env", docs[0] |
| ) |
| assert { |
| "name": "git-sync-ssh-key", |
| "secret": {"secretName": "ssh-secret", "defaultMode": 288}, |
| } in jmespath.search("spec.template.spec.volumes", docs[0]) |
| |
| def test_validate_sshkeysecret_not_added_when_persistence_is_enabled(self): |
| docs = render_chart( |
| values={ |
| "dags": { |
| "gitSync": { |
| "enabled": True, |
| "containerName": "git-sync-test", |
| "sshKeySecret": "ssh-secret", |
| "knownHosts": None, |
| "branch": "test-branch", |
| }, |
| "persistence": {"enabled": True}, |
| } |
| }, |
| show_only=["templates/scheduler/scheduler-deployment.yaml"], |
| ) |
| assert "git-sync-ssh-key" not in jmespath.search("spec.template.spec.volumes[].name", docs[0]) |
| |
| def test_should_set_username_and_pass_env_variables(self): |
| docs = render_chart( |
| values={ |
| "dags": { |
| "gitSync": { |
| "enabled": True, |
| "credentialsSecret": "user-pass-secret", |
| "sshKeySecret": None, |
| } |
| } |
| }, |
| show_only=["templates/scheduler/scheduler-deployment.yaml"], |
| ) |
| |
| assert { |
| "name": "GIT_SYNC_USERNAME", |
| "valueFrom": {"secretKeyRef": {"name": "user-pass-secret", "key": "GIT_SYNC_USERNAME"}}, |
| } in jmespath.search("spec.template.spec.containers[1].env", docs[0]) |
| assert { |
| "name": "GIT_SYNC_PASSWORD", |
| "valueFrom": {"secretKeyRef": {"name": "user-pass-secret", "key": "GIT_SYNC_PASSWORD"}}, |
| } in jmespath.search("spec.template.spec.containers[1].env", docs[0]) |
| |
| def test_should_set_the_volume_claim_correctly_when_using_an_existing_claim(self): |
| docs = render_chart( |
| values={"dags": {"persistence": {"enabled": True, "existingClaim": "test-claim"}}}, |
| show_only=["templates/scheduler/scheduler-deployment.yaml"], |
| ) |
| |
| assert {"name": "dags", "persistentVolumeClaim": {"claimName": "test-claim"}} in jmespath.search( |
| "spec.template.spec.volumes", docs[0] |
| ) |
| |
| def test_should_add_extra_volume_and_extra_volume_mount(self): |
| docs = render_chart( |
| values={ |
| "executor": "CeleryExecutor", |
| "scheduler": { |
| "extraVolumes": [{"name": "test-volume", "emptyDir": {}}], |
| "extraVolumeMounts": [{"name": "test-volume", "mountPath": "/opt/test"}], |
| }, |
| "dags": { |
| "gitSync": { |
| "enabled": True, |
| } |
| }, |
| }, |
| show_only=["templates/scheduler/scheduler-deployment.yaml"], |
| ) |
| |
| assert {"name": "test-volume", "emptyDir": {}} in jmespath.search( |
| "spec.template.spec.volumes", docs[0] |
| ) |
| assert {"name": "test-volume", "mountPath": "/opt/test"} in jmespath.search( |
| "spec.template.spec.containers[0].volumeMounts", docs[0] |
| ) |
| |
| def test_extra_volume_and_git_sync_extra_volume_mount(self): |
| docs = render_chart( |
| values={ |
| "executor": "CeleryExecutor", |
| "scheduler": { |
| "extraVolumes": [{"name": "test-volume", "emptyDir": {}}], |
| }, |
| "dags": { |
| "gitSync": { |
| "enabled": True, |
| "extraVolumeMounts": [{"mountPath": "/opt/test", "name": "test-volume"}], |
| } |
| }, |
| }, |
| show_only=["templates/scheduler/scheduler-deployment.yaml"], |
| ) |
| |
| assert {"name": "test-volume", "emptyDir": {}} in jmespath.search( |
| "spec.template.spec.volumes", docs[0] |
| ) |
| assert {'mountPath': '/git', 'name': 'dags'} in jmespath.search( |
| "spec.template.spec.containers[1].volumeMounts", docs[0] |
| ) |
| assert {"name": "test-volume", "mountPath": "/opt/test"} in jmespath.search( |
| "spec.template.spec.containers[1].volumeMounts", docs[0] |
| ) |
| |
| def test_should_add_env(self): |
| docs = render_chart( |
| values={ |
| "dags": { |
| "gitSync": { |
| "enabled": True, |
| "env": [{"name": "FOO", "value": "bar"}], |
| } |
| }, |
| }, |
| show_only=["templates/scheduler/scheduler-deployment.yaml"], |
| ) |
| |
| assert {"name": "FOO", "value": "bar"} in jmespath.search( |
| "spec.template.spec.containers[1].env", docs[0] |
| ) |
| |
| def test_resources_are_configurable(self): |
| docs = render_chart( |
| values={ |
| "dags": { |
| "gitSync": { |
| "enabled": True, |
| "resources": { |
| "limits": {"cpu": "200m", 'memory': "128Mi"}, |
| "requests": {"cpu": "300m", 'memory': "169Mi"}, |
| }, |
| }, |
| }, |
| }, |
| show_only=["templates/scheduler/scheduler-deployment.yaml"], |
| ) |
| assert "128Mi" == jmespath.search("spec.template.spec.containers[1].resources.limits.memory", docs[0]) |
| assert "169Mi" == jmespath.search( |
| "spec.template.spec.containers[1].resources.requests.memory", docs[0] |
| ) |
| assert "300m" == jmespath.search("spec.template.spec.containers[1].resources.requests.cpu", docs[0]) |
