Repository: kubeflow/pipelines

Issue:
feat(backend): Support environment variables



Discussion:

Resolving patch:
diff --git a/samples/v2/pipeline_with_env.py b/samples/v2/pipeline_with_env.py
new file mode 100644
--- /dev/null
+++ b/samples/v2/pipeline_with_env.py
@@ -0,0 +1,61 @@
+# Copyright 2023 The Kubeflow Authors
+#
+# Licensed 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.
+from kfp import compiler
+from kfp import components
+from kfp import dsl
+from kfp.dsl import component
+
+
+@component
+def print_env_op():
+    import os
+    print('ENV1', os.environ.get('ENV1'))
+    print('ENV2', os.environ.get('ENV2'))
+
+
+print_env_2_op = components.load_component_from_text("""
+name: Check env
+implementation:
+  container:
+    image: alpine
+    command:
+    - sh
+    - -c
+    - |
+      set -e -x
+      if [ "$ENV2" == "val2" ]
+      then
+        echo "$ENV2" 
+      else 
+        echo "ENV2 does not equal val2"
+        exit 1
+      fi
+      echo "$ENV3"
+    env:
+      ENV2: val0
+""")
+
+
+@dsl.pipeline(name='pipeline-with-env', pipeline_root='dummy_root')
+def pipeline_with_env():
+    print_env_op().set_env_variable(name='ENV1', value='val1')
+    print_env_2_op().set_env_variable(
+        name='ENV2', value='val2').set_env_variable(
+            name='ENV3', value='val3')
+
+
+if __name__ == '__main__':
+    compiler.Compiler().compile(
+        pipeline_func=pipeline_with_env,
+        package_path='pipeline_with_env.yaml')
\ No newline at end of file


Test patch:
diff --git a/samples/test/config.yaml b/samples/test/config.yaml
--- a/samples/test/config.yaml
+++ b/samples/test/config.yaml
@@ -126,6 +126,8 @@
   path: samples.v2.pipeline_container_no_input_test
 - name: two_step_pipeline_containerized
   path: samples.v2.two_step_pipeline_containerized_test
+- name: pipeline_with_env
+  path: samples.v2.pipeline_with_env_test
 # TODO(capri-xiyue): Re-enable after figuring out V2 Engine
 # and protobuf.Value support.
 # - name: cache_v2
diff --git a/samples/v2/pipeline_with_env_test.py b/samples/v2/pipeline_with_env_test.py
new file mode 100644
--- /dev/null
+++ b/samples/v2/pipeline_with_env_test.py
@@ -0,0 +1,64 @@
+# Copyright 2023 The Kubeflow Authors
+#
+# Licensed 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.
+"""Hello world v2 engine pipeline."""
+
+from __future__ import annotations
+
+import unittest
+
+import kfp.deprecated as kfp
+import kfp_server_api
+from ml_metadata.proto import Execution
+
+from kfp.samples.test.utils import KfpTask, TaskInputs, TaskOutputs, TestCase, run_pipeline_func
+from .pipeline_with_env import pipeline_with_env
+
+
+def verify(t: unittest.TestCase, run: kfp_server_api.ApiRun,
+           tasks: dict[str, KfpTask], **kwargs):
+    t.assertEqual(run.status, 'Succeeded')
+    t.assertEqual(
+        {
+            'print-env-op':
+                KfpTask(
+                    name='print-env-op',
+                    type='system.ContainerExecution',
+                    state=Execution.State.COMPLETE,
+                    inputs=TaskInputs(
+                        parameters={}, artifacts=[]),
+                    outputs=TaskOutputs(
+                        parameters={}, artifacts=[])),
+            'check-env':
+                KfpTask(
+                    name='check-env',
+                    type='system.ContainerExecution',
+                    state=Execution.State.COMPLETE,
+                    inputs=TaskInputs(
+                        parameters={}, artifacts=[]),
+                    outputs=TaskOutputs(
+                        parameters={}, artifacts=[])),
+
+        },
+        tasks,
+    )
+
+
+if __name__ == '__main__':
+    run_pipeline_func([
+        TestCase(
+            pipeline_func=pipeline_with_env,
+            verify_func=verify,
+            mode=kfp.dsl.PipelineExecutionMode.V2_ENGINE,
+        ),
+    ])
\ No newline at end of file