[jira] [Commented] (AIRFLOW-2875) Env variables should have percent signs escaped before writing to tmp config

["ASF GitHub Bot (JIRA)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/AIRFLOW-2875?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16573560#comment-16573560 ] 

ASF GitHub Bot commented on AIRFLOW-2875:
-----------------------------------------

wdhorton opened a new pull request #3721: [AIRFLOW-2875] Escape env vars in tmp config
URL: https://github.com/apache/incubator-airflow/pull/3721
 
 
   Make sure you have checked _all_ steps below.
   
   ### Jira
   
   - [ ] My PR addresses the following [Airflow Jira](https://issues.apache.org/jira/browse/AIRFLOW/) issues and references them in the PR title. For example, "\[AIRFLOW-XXX\] My Airflow PR"
     - https://issues.apache.org/jira/browse/AIRFLOW-XXX
     - In case you are fixing a typo in the documentation you can prepend your commit with \[AIRFLOW-XXX\], code changes always need a Jira issue.
   
   ### Description
   
   - [ ] Here are some details about my PR, including screenshots of any UI changes:
   When writing tmp config files, escapes the env variables, since they are read by `ConfigParser` when the tmp config file is loaded when the task is being run.
   
   ### Tests
   
   - [ ] My PR adds the following unit tests __OR__ does not need testing for this extremely good reason:
   
   ### Commits
   
   - [ ] My commits all reference Jira issues in their subject lines, and I have squashed multiple commits if they address the same issue. In addition, my commits follow the guidelines from "[How to write a good git commit message](http://chris.beams.io/posts/git-commit/)":
     1. Subject is separated from body by a blank line
     1. Subject is limited to 50 characters (not including Jira issue reference)
     1. Subject does not end with a period
     1. Subject uses the imperative mood ("add", not "adding")
     1. Body wraps at 72 characters
     1. Body explains "what" and "why", not "how"
   
   ### Documentation
   
   - [ ] In case of new functionality, my PR adds documentation that describes how to use it.
     - When adding new operators/hooks/sensors, the autoclass documentation generation needs to be added.
   
   ### Code Quality
   
   - [ ] Passes `git diff upstream/master -u -- "*.py" | flake8 --diff`
   

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on 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


> Env variables should have percent signs escaped before writing to tmp config
> ----------------------------------------------------------------------------
>
>                 Key: AIRFLOW-2875
>                 URL: https://issues.apache.org/jira/browse/AIRFLOW-2875
>             Project: Apache Airflow
>          Issue Type: Bug
>          Components: configuration
>         Environment: Ubuntu
> Airflow 1.10rc2
>            Reporter: William Horton
>            Priority: Major
>
> I encountered this when I was using an environment variable for `AIRFLOW__CELERY__BROKER_URL`. The airflow worker was able to run and communicate with the SQS queue, but when it received a task and began to run it, I encountered an error with this trace:
> {code:java}
> [2018-08-08 15:19:24,402] {base_task_runner.py:108} INFO - Job 13898: Subtask mirroring Traceback (most recent call last):
> [2018-08-08 15:19:24,402] {base_task_runner.py:108} INFO - Job 13898: Subtask mirroring File "/opt/airflow/venv/bin/airflow", line 32, in <module>
> [2018-08-08 15:19:24,402] {base_task_runner.py:108} INFO - Job 13898: Subtask mirroring args.func(args)
> [2018-08-08 15:19:24,402] {base_task_runner.py:108} INFO - Job 13898: Subtask mirroring File "/opt/airflow/venv/local/lib/python2.7/site-packages/airflow/utils/cli.py", line 74, in wrapper
> [2018-08-08 15:19:24,402] {base_task_runner.py:108} INFO - Job 13898: Subtask mirroring return f(*args, **kwargs)
> [2018-08-08 15:19:24,402] {base_task_runner.py:108} INFO - Job 13898: Subtask mirroring File "/opt/airflow/venv/local/lib/python2.7/site-packages/airflow/bin/cli.py", line 460, in run
> [2018-08-08 15:19:24,403] {base_task_runner.py:108} INFO - Job 13898: Subtask mirroring conf.set(section, option, value)
> [2018-08-08 15:19:24,403] {base_task_runner.py:108} INFO - Job 13898: Subtask mirroring File "/opt/airflow/venv/local/lib/python2.7/site-packages/backports/configparser/_init_.py", line 1239, in set
> [2018-08-08 15:19:24,406] {base_task_runner.py:108} INFO - Job 13898: Subtask mirroring super(ConfigParser, self).set(section, option, value)
> [2018-08-08 15:19:24,406] {base_task_runner.py:108} INFO - Job 13898: Subtask mirroring File "/opt/airflow/venv/local/lib/python2.7/site-packages/backports/configparser/_init_.py", line 914, in set
> [2018-08-08 15:19:24,406] {base_task_runner.py:108} INFO - Job 13898: Subtask mirroring value)
> [2018-08-08 15:19:24,406] {base_task_runner.py:108} INFO - Job 13898: Subtask mirroring File "/opt/airflow/venv/local/lib/python2.7/site-packages/backports/configparser/_init_.py", line 392, in before_set
> [2018-08-08 15:19:24,406] {base_task_runner.py:108} INFO - Job 13898: Subtask mirroring "position %d" % (value, tmp_value.find('%')))
> [2018-08-08 15:19:24,406] {base_task_runner.py:108} INFO - Job 13898: Subtask mirroring ValueError: invalid interpolation syntax in <redacted-broker-url>{code}
> The issue was that the broker url had a percent sign, and when the cli called `conf.set(section, option, value)`, it was throwing because it interpreted the percent as an interpolation.
> To avoid this issue, I would propose that the environment variables be escaped when being written in `utils.configuration.tmp_configuration_copy`, so that when `conf.set` is called in `bin/cli`, it doesn't throw on these unescaped values.



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)