Refactoring: Moved hard coded environment variables' names into constants. (#25365)

* Refactoring: Moved hard coded environment names into constants

* Add apache license header to playground/infrastructure/constants.py

* Fix imports in playground/infrastructure/

* [Playground]: refactor error messages

* Update playground/infrastructure/constants.py

Co-authored-by: Timur Sultanov <tssultanov@outlook.com>

---------

Co-authored-by: Timur Sultanov <tssultanov@outlook.com>

Author: sultanalieva-s

playground/infrastructure/checker.py

@@ -31,6 +31,7 @@
 from api.v1.api_pb2 import Sdk
 from config import Config
 from helper import get_tag, load_supported_categories
+from constants import BEAM_EXAMPLE_CATEGORIES_ENV_VAR_KEY, BEAM_ROOT_DIR_ENV_VAR_KEY
 
 
 def parse_args() -> argparse.Namespace:
@@ -90,12 +91,12 @@ def check_sdk_examples(paths: List[PurePath], sdk: Sdk, root_dir: str) -> bool:
 def main():
     args = parse_args()
 
-    root_dir = os.getenv("BEAM_ROOT_DIR")
+    root_dir = os.getenv(BEAM_ROOT_DIR_ENV_VAR_KEY)
     if root_dir is None:
-        raise KeyError("BEAM_ROOT_DIR environment variable should be specified in os")
-    categories_file = os.getenv("BEAM_EXAMPLE_CATEGORIES")
+        raise KeyError(f"{BEAM_ROOT_DIR_ENV_VAR_KEY} environment variable should be specified in os")
+    categories_file = os.getenv(BEAM_EXAMPLE_CATEGORIES_ENV_VAR_KEY)
     if categories_file is None:
-        raise KeyError("BEAM_EXAMPLE_CATEGORIES environment variable should be specified in os")
+        raise KeyError(f"{BEAM_EXAMPLE_CATEGORIES_ENV_VAR_KEY} environment variable should be specified in os")
 
     load_supported_categories(categories_file)
 

playground/infrastructure/ci_cd.py

@@ -22,6 +22,7 @@
 import os
 from typing import List
 
+from constants import BEAM_ROOT_DIR_ENV_VAR_KEY, BEAM_EXAMPLE_CATEGORIES_ENV_VAR_KEY
 from models import SdkEnum, Example, StringToSdkEnum
 from config import Config, Origin
 from datastore_client import DatastoreClient
@@ -77,8 +78,8 @@
     help="limit sub directories to walk through, relative to BEAM_ROOT_DIR",
 )
 
-root_dir = os.getenv("BEAM_ROOT_DIR")
-categories_file = os.getenv("BEAM_EXAMPLE_CATEGORIES")
+root_dir = os.getenv(BEAM_ROOT_DIR_ENV_VAR_KEY)
+categories_file = os.getenv(BEAM_EXAMPLE_CATEGORIES_ENV_VAR_KEY)
 
 
 def _check_envs():

playground/infrastructure/config.py

@@ -26,14 +26,15 @@
     STATUS_PREPARATION_ERROR, STATUS_COMPILE_ERROR, \
     STATUS_RUN_TIMEOUT, STATUS_RUN_ERROR, SDK_JAVA, SDK_GO, SDK_PYTHON, \
     SDK_SCIO, Sdk
+from constants import SERVER_ADDRESS_ENV_VAR_KEY, SDK_CONFIG_ENV_VAR_KEY
 
 
 @dataclass(frozen=True)
 class Config:
     """
     General configuration for CI/CD steps
     """
-    SERVER_ADDRESS = os.getenv("SERVER_ADDRESS", "localhost:8080")
+    SERVER_ADDRESS = os.getenv(SERVER_ADDRESS_ENV_VAR_KEY, "localhost:8080")
     EXTENSION_TO_SDK = {
         "java": SDK_JAVA, "go": SDK_GO, "py": SDK_PYTHON, "scala": SDK_SCIO
     }
@@ -60,7 +61,7 @@ class Config:
     CD_STEP_NAME = "CD"
     CI_CD_LITERAL = Literal["CI", "CD"]
     URL_VCS_PREFIX = "https://github.com/apache/beam/blob/master"
-    SDK_CONFIG = os.getenv("SDK_CONFIG", "../../playground/sdks.yaml")
+    SDK_CONFIG = os.getenv(SDK_CONFIG_ENV_VAR_KEY, "../../playground/sdks.yaml")
     DEFAULT_NAMESPACE = "Playground"
 
 

playground/infrastructure/constants.py

@@ -0,0 +1,21 @@
+# 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.
+
+BEAM_ROOT_DIR_ENV_VAR_KEY = "BEAM_ROOT_DIR"
+BEAM_EXAMPLE_CATEGORIES_ENV_VAR_KEY = "BEAM_EXAMPLE_CATEGORIES"
+SERVER_ADDRESS_ENV_VAR_KEY = "SERVER_ADDRESS"
+SDK_CONFIG_ENV_VAR_KEY = "SDK_CONFIG"
+BEAM_USE_WEBGRPC_ENV_VAR_KEY = "BEAM_USE_WEBGRPC"
+GRPC_TIMEOUT_ENV_VAR_KEY = "GRPC_TIMEOUT"

playground/infrastructure/grpc_client.py

@@ -26,15 +26,16 @@
 
 from api.v1 import api_pb2_grpc, api_pb2
 from config import Config
+from constants import BEAM_USE_WEBGRPC_ENV_VAR_KEY, GRPC_TIMEOUT_ENV_VAR_KEY
 from models import SdkEnum
 
 
 class GRPCClient:
     """GRPCClient is gRPC client for sending a request to the backend."""
 
     def __init__(self, wait_for_ready=True):
-        use_webgrpc = os.getenv("BEAM_USE_WEBGRPC", False)
-        timeout = int(os.getenv("GRPC_TIMEOUT", 30))
+        use_webgrpc = os.getenv(BEAM_USE_WEBGRPC_ENV_VAR_KEY, False)
+        timeout = int(os.getenv(GRPC_TIMEOUT_ENV_VAR_KEY, 30))
         logging.info("grpc timeout: %d", timeout)
         if use_webgrpc:
             self._channel = sonora.aio.insecure_web_channel(Config.SERVER_ADDRESS)

playground/infrastructure/helper.py

@@ -44,6 +44,7 @@
 )
 from config import Config, TagFields, PrecompiledExampleType
 from grpc_client import GRPCClient
+from constants import BEAM_ROOT_DIR_ENV_VAR_KEY
 
 from models import Example, Tag, SdkEnum, Dataset
 
@@ -261,7 +262,7 @@ def _get_url_vcs(filepath: str) -> str:
     """
     Construct VCS URL from example's filepath
     """
-    root_dir = os.getenv("BEAM_ROOT_DIR", "../..")
+    root_dir = os.getenv(BEAM_ROOT_DIR_ENV_VAR_KEY, "../..")
     rel_path = os.path.relpath(filepath, root_dir)
     url_vcs = "{}/{}".format(Config.URL_VCS_PREFIX, urllib.parse.quote(rel_path))
     return url_vcs