You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airflow.apache.org by GitBox <gi...@apache.org> on 2021/02/24 14:46:28 UTC
[GitHub] [airflow] ashb opened a new pull request #14420: Don't create unittest.cfg when not running in unit test mode
ashb opened a new pull request #14420:
URL: https://github.com/apache/airflow/pull/14420
Right now on airflow startup it would _always_ create a unittest.cfg,
even if unit test mode was not enabled.
This PR changes it so that this file is only created when unit tests
mode is enabled (via the environment variable).
I have also refactored the mess of top-level code that was interspersed
between functions to all be at one place -- at the end of the file.
The bulk of the config loading code now lives in the `initialize_config`
function.
<!--
Thank you for contributing! Please make sure that your code changes
are covered with tests. And in case of new features or big changes
remember to adjust the documentation.
Feel free to ping committers for the review!
In case of existing issue, reference it using one of the following:
closes: #ISSUE
related: #ISSUE
How to write a good git commit message:
http://chris.beams.io/posts/git-commit/
-->
---
**^ Add meaningful description above**
Read the **[Pull Request Guidelines](https://github.com/apache/airflow/blob/master/CONTRIBUTING.rst#pull-request-guidelines)** for more information.
In case of fundamental code change, Airflow Improvement Proposal ([AIP](https://cwiki.apache.org/confluence/display/AIRFLOW/Airflow+Improvements+Proposals)) is needed.
In case of a new dependency, check compliance with the [ASF 3rd Party License Policy](https://www.apache.org/legal/resolved.html#category-x).
In case of backwards incompatible changes please leave a note in [UPDATING.md](https://github.com/apache/airflow/blob/master/UPDATING.md).
----------------------------------------------------------------
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
[GitHub] [airflow] ashb merged pull request #14420: Don't create unittest.cfg when not running in unit test mode
Posted by GitBox <gi...@apache.org>.
ashb merged pull request #14420:
URL: https://github.com/apache/airflow/pull/14420
----------------------------------------------------------------
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
[GitHub] [airflow] ashb commented on pull request #14420: Don't create unittest.cfg when not running in unit test mode
Posted by GitBox <gi...@apache.org>.
ashb commented on pull request #14420:
URL: https://github.com/apache/airflow/pull/14420#issuecomment-786000289
This is been on my "I want to do this" list for about.... 3 years. FInially got annoyed enough to do it!
----------------------------------------------------------------
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
[GitHub] [airflow] github-actions[bot] commented on pull request #14420: Don't create unittest.cfg when not running in unit test mode
Posted by GitBox <gi...@apache.org>.
github-actions[bot] commented on pull request #14420:
URL: https://github.com/apache/airflow/pull/14420#issuecomment-785235234
The PR most likely needs to run full matrix of tests because it modifies parts of the core of Airflow. However, committers might decide to merge it quickly and take the risk. If they don't merge it quickly - please rebase it to the latest master at your convenience, or amend the last commit of the PR, and push it with --force-with-lease.
----------------------------------------------------------------
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
[GitHub] [airflow] ashb commented on pull request #14420: Don't create unittest.cfg when not running in unit test mode
Posted by GitBox <gi...@apache.org>.
ashb commented on pull request #14420:
URL: https://github.com/apache/airflow/pull/14420#issuecomment-786079326
Dang, consistent failure in `tests/operators/test_python.py::TestPythonVirtualenvOperator::test_airflow_context` 🤔
----------------------------------------------------------------
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
[GitHub] [airflow] ashb commented on pull request #14420: Don't create unittest.cfg when not running in unit test mode
Posted by GitBox <gi...@apache.org>.
ashb commented on pull request #14420:
URL: https://github.com/apache/airflow/pull/14420#issuecomment-785927208
Tests should be fixed, and I've added backcompat for the `DEFAULT_CONFIG` etc constants just in case someone was using them.
----------------------------------------------------------------
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
[GitHub] [airflow] ashb commented on a change in pull request #14420: Don't create unittest.cfg when not running in unit test mode
Posted by GitBox <gi...@apache.org>.
ashb commented on a change in pull request #14420:
URL: https://github.com/apache/airflow/pull/14420#discussion_r582932864
##########
File path: scripts/in_container/airflow_ci.cfg
##########
@@ -44,12 +44,6 @@ smtp_mail_from = airflow@example.com
broker_url = amqp://guest:guest@rabbitmq:5672/
result_backend = # overridden by startup scripts
-[celery_broker_transport_options]
Review comment:
This is moved out of here in to default_test.cfg so that the config tests pass outside of breeze.
----------------------------------------------------------------
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
[GitHub] [airflow] ashb commented on pull request #14420: Don't create unittest.cfg when not running in unit test mode
Posted by GitBox <gi...@apache.org>.
ashb commented on pull request #14420:
URL: https://github.com/apache/airflow/pull/14420#issuecomment-786093971
Oh wat. using Pep562 in the module somehow makes AirflowConfigParser unpickelable!
----------------------------------------------------------------
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
[GitHub] [airflow] turbaszek commented on a change in pull request #14420: Don't create unittest.cfg when not running in unit test mode
Posted by GitBox <gi...@apache.org>.
turbaszek commented on a change in pull request #14420:
URL: https://github.com/apache/airflow/pull/14420#discussion_r582939080
##########
File path: airflow/configuration.py
##########
@@ -779,65 +758,93 @@ def get_airflow_test_config(airflow_home):
return expand_env_var(os.environ['AIRFLOW_TEST_CONFIG'])
-TEST_CONFIG_FILE = get_airflow_test_config(AIRFLOW_HOME)
+def _generate_fernet_key():
+ from cryptography.fernet import Fernet
-# only generate a Fernet key if we need to create a new config file
-if not os.path.isfile(TEST_CONFIG_FILE) or not os.path.isfile(AIRFLOW_CONFIG):
- FERNET_KEY = Fernet.generate_key().decode()
-else:
- FERNET_KEY = ''
+ return Fernet.generate_key().decode()
-SECRET_KEY = b64encode(os.urandom(16)).decode('utf-8')
-TEMPLATE_START = '# ----------------------- TEMPLATE BEGINS HERE -----------------------'
-if not os.path.isfile(TEST_CONFIG_FILE):
- log.info('Creating new Airflow config file for unit tests in: %s', TEST_CONFIG_FILE)
- with open(TEST_CONFIG_FILE, 'w') as file:
- cfg = parameterized_config(TEST_CONFIG)
- file.write(cfg.split(TEMPLATE_START)[-1].strip())
-if not os.path.isfile(AIRFLOW_CONFIG):
- log.info('Creating new Airflow config file in: %s', AIRFLOW_CONFIG)
- with open(AIRFLOW_CONFIG, 'w') as file:
- cfg = parameterized_config(DEFAULT_CONFIG)
- cfg = cfg.split(TEMPLATE_START)[-1].strip()
- file.write(cfg)
-
-log.info("Reading the config from %s", AIRFLOW_CONFIG)
-
-conf = AirflowConfigParser(default_config=parameterized_config(DEFAULT_CONFIG))
-
-conf.read(AIRFLOW_CONFIG)
-
-if conf.has_option('core', 'AIRFLOW_HOME'):
- msg = (
- 'Specifying both AIRFLOW_HOME environment variable and airflow_home '
- 'in the config file is deprecated. Please use only the AIRFLOW_HOME '
- 'environment variable and remove the config file entry.'
- )
- if 'AIRFLOW_HOME' in os.environ:
- warnings.warn(msg, category=DeprecationWarning)
- elif conf.get('core', 'airflow_home') == AIRFLOW_HOME:
- warnings.warn(
- 'Specifying airflow_home in the config file is deprecated. As you '
- 'have left it at the default value you should remove the setting '
- 'from your airflow.cfg and suffer no change in behaviour.',
- category=DeprecationWarning,
- )
+def initialize_config():
+ """
+ Load the Airflow config files.
+
+ Called for you automatically as part of the Airflow boot process.
+ """
+ global FERNET_KEY, AIRFLOW_HOME
+
+ default_config = _parameterized_config_from_template('default_airflow.cfg')
+
+ conf = AirflowConfigParser(default_config=default_config)
+
+ if conf.getboolean('core', 'unit_test_mode'):
+ # Load test config only
+ if not os.path.isfile(TEST_CONFIG_FILE):
+ from cryptography.fernet import Fernet
+
+ log.info('Creating new Airflow config file for unit tests in: %s', TEST_CONFIG_FILE)
+ pathlib.Path(AIRFLOW_HOME).mkdir(parents=True, exist_ok=True)
+
+ FERNET_KEY = Fernet.generate_key().decode()
+
+ with open(TEST_CONFIG_FILE, 'w') as file:
+ cfg = _parameterized_config_from_template('default_test.cfg')
+ file.write(cfg)
+
+ conf.load_test_config()
else:
- AIRFLOW_HOME = conf.get('core', 'airflow_home')
- warnings.warn(msg, category=DeprecationWarning)
+ # Load normal config
+ if not os.path.isfile(AIRFLOW_CONFIG):
+ from cryptography.fernet import Fernet
+ log.info('Creating new Airflow config file in: %s', AIRFLOW_CONFIG)
+ pathlib.Path(AIRFLOW_HOME).mkdir(parents=True, exist_ok=True)
-WEBSERVER_CONFIG = AIRFLOW_HOME + '/webserver_config.py'
+ FERNET_KEY = Fernet.generate_key().decode()
-if not os.path.isfile(WEBSERVER_CONFIG):
- log.info('Creating new FAB webserver config file in: %s', WEBSERVER_CONFIG)
- DEFAULT_WEBSERVER_CONFIG, _ = _read_default_config_file('default_webserver_config.py')
- with open(WEBSERVER_CONFIG, 'w') as file:
- file.write(DEFAULT_WEBSERVER_CONFIG)
+ with open(AIRFLOW_CONFIG, 'w') as file:
+ file.write(default_config)
-if conf.getboolean('core', 'unit_test_mode'):
- conf.load_test_config()
+ log.info("Reading the config from %s", AIRFLOW_CONFIG)
+
+ conf.read(AIRFLOW_CONFIG)
+
+ if conf.has_option('core', 'AIRFLOW_HOME'):
+ msg = (
+ 'Specifying both AIRFLOW_HOME environment variable and airflow_home '
+ 'in the config file is deprecated. Please use only the AIRFLOW_HOME '
+ 'environment variable and remove the config file entry.'
+ )
+ if 'AIRFLOW_HOME' in os.environ:
+ warnings.warn(msg, category=DeprecationWarning)
+ elif conf.get('core', 'airflow_home') == AIRFLOW_HOME:
+ warnings.warn(
+ 'Specifying airflow_home in the config file is deprecated. As you '
+ 'have left it at the default value you should remove the setting '
+ 'from your airflow.cfg and suffer no change in behaviour.',
+ category=DeprecationWarning,
+ )
+ else:
+ AIRFLOW_HOME = conf.get('core', 'airflow_home')
+ warnings.warn(msg, category=DeprecationWarning)
+
+ # They _might_ have set unit_test_mode in the airflow.cfg, we still
+ # want to respect that and then load the unittests.cfg
+ if conf.getboolean('core', 'unit_test_mode'):
+ conf.load_test_config()
+
+ # Make it no longer a proxy variable, just set it to an actual string
+ global WEBSERVER_CONFIG
+ WEBSERVER_CONFIG = AIRFLOW_HOME + '/webserver_config.py'
Review comment:
```suggestion
WEBSERVER_CONFIG = os.path.join(AIRFLOW_HOME, 'webserver_config.py')
```
----------------------------------------------------------------
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
[GitHub] [airflow] ashb commented on a change in pull request #14420: Don't create unittest.cfg when not running in unit test mode
Posted by GitBox <gi...@apache.org>.
ashb commented on a change in pull request #14420:
URL: https://github.com/apache/airflow/pull/14420#discussion_r582933484
##########
File path: scripts/in_container/airflow_ci.cfg
##########
@@ -44,12 +44,6 @@ smtp_mail_from = airflow@example.com
broker_url = amqp://guest:guest@rabbitmq:5672/
result_backend = # overridden by startup scripts
-[celery_broker_transport_options]
Review comment:
Actually, scratch this. I'm going to revert this change.
----------------------------------------------------------------
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
[GitHub] [airflow] github-actions[bot] commented on pull request #14420: Don't create unittest.cfg when not running in unit test mode
Posted by GitBox <gi...@apache.org>.
github-actions[bot] commented on pull request #14420:
URL: https://github.com/apache/airflow/pull/14420#issuecomment-785145659
[The Workflow run](https://github.com/apache/airflow/actions/runs/596458133) is cancelling this PR. It has some failed jobs matching ^Pylint$,^Static checks,^Build docs$,^Spell check docs$,^Backport packages$,^Provider packages,^Checks: Helm tests$,^Test OpenAPI*.
----------------------------------------------------------------
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