[GitHub] [airflow] ashb commented on a change in pull request #6229: [AIRFLOW-5580] Add base class for system test

[GitBox <gi...@apache.org>]

ashb commented on a change in pull request #6229: [AIRFLOW-5580] Add base class for system test
URL: https://github.com/apache/airflow/pull/6229#discussion_r331779089
 
 

 ##########
 File path: tests/test_utils/system_tests_class.py
 ##########
 @@ -0,0 +1,149 @@
+# -*- coding: utf-8 -*-
+#
+# 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 os
+from contextlib import ContextDecorator
+from shutil import move
+from tempfile import mkdtemp
+from unittest import TestCase, skip
+
+from airflow import AirflowException, models
+from airflow.configuration import AIRFLOW_HOME, AirflowConfigParser, get_airflow_config
+from airflow.utils import db
+from airflow.utils.log.logging_mixin import LoggingMixin
+
+DEFAULT_DAG_FOLDER = "example_dags"
+
+SKIP_SYSTEM_TEST_WARNING = """Skipping system test.
+To allow system test set ENABLE_SYSTEM_TESTS=true.
+"""
+
+
+def resolve_dags_folder() -> str:
+    """
+    Returns DAG folder specified in current Airflow config.
+    """
+    config_file = get_airflow_config(AIRFLOW_HOME)
+    conf = AirflowConfigParser()
+    conf.read(config_file)
+    try:
+        dags = conf.get("core", "dags_folder")
+    except AirflowException:
+        dags = os.path.join(AIRFLOW_HOME, 'dags')
+    return dags
+
+
+class empty_dags_directory(  # pylint:disable=invalid-name
+    ContextDecorator, LoggingMixin
+):
+    """
+    Context manager that temporally removes DAGs from provided directory.
+    """
+
+    def __init__(self, dag_directory: str) -> None:
+        super().__init__()
+        self.dag_directory = dag_directory
+        self.temp_dir = mkdtemp()
+
+    def __enter__(self) -> str:
+        self._store_dags_to_temporary_directory(self.dag_directory, self.temp_dir)
+        return self.temp_dir
+
+    def __exit__(self, *args, **kwargs) -> None:
+        self._restore_dags_from_temporary_directory(self.dag_directory, self.temp_dir)
+
+    def _store_dags_to_temporary_directory(
+        self, dag_folder: str, temp_dir: str
+    ) -> None:
+        self.log.info(
+            "Storing DAGS from %s to temporary directory %s", dag_folder, temp_dir
+        )
+        try:
+            os.mkdir(dag_folder)
+        except OSError:
+            pass
+        for file in os.listdir(dag_folder):
+            move(os.path.join(dag_folder, file), os.path.join(temp_dir, file))
+
+    def _restore_dags_from_temporary_directory(
+        self, dag_folder: str, temp_dir: str
+    ) -> None:
+        self.log.info(
+            "Restoring DAGS to %s from temporary directory %s", dag_folder, temp_dir
+        )
+        for file in os.listdir(temp_dir):
+            move(os.path.join(temp_dir, file), os.path.join(dag_folder, file))
+
+
+class SystemTest(TestCase, LoggingMixin):
+    @staticmethod
+    def skip():
+        if os.environ.get('ENABLE_SYSTEM_TESTS') != 'true':
+            return skip(SKIP_SYSTEM_TEST_WARNING)
+        return lambda cls: cls
+
+    def setUp(self) -> None:
+        """
+        We want to avoid random errors while database got reset - those
+        Are apparently triggered by parser trying to parse DAGs while
+        The tables are dropped. We move the dags temporarily out of the dags folder
+        and move them back after reset
+        """
+        dag_folder = resolve_dags_folder()
+        with empty_dags_directory(dag_folder):
+            db.upgradedb()
+            db.resetdb()
 
 Review comment:
   Resetdb does upgrade, there's no need to do both

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services