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 2020/06/04 14:01:04 UTC
[GitHub] [airflow] ashb opened a new pull request #9143: Add note about using dag_run.conf in BashOperator
ashb opened a new pull request #9143:
URL: https://github.com/apache/airflow/pull/9143
---
Make sure to mark the boxes below before creating PR: [x]
- [x] Description above provides context of the change
- [x] Unit tests coverage for changes (not needed for documentation changes)
- [x] Target Github ISSUE in description if exists
- [x] Commits follow "[How to write a good git commit message](http://chris.beams.io/posts/git-commit/)"
- [x] Relevant documentation is updated including usage instructions.
- [x] I will engage committers as explained in [Contribution Workflow Example](https://github.com/apache/airflow/blob/master/CONTRIBUTING.rst#contribution-workflow-example).
---
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).
Read the [Pull Request Guidelines](https://github.com/apache/airflow/blob/master/CONTRIBUTING.rst#pull-request-guidelines) for more information.
----------------------------------------------------------------
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 #9143: Add note about using dag_run.conf in BashOperator
Posted by GitBox <gi...@apache.org>.
ashb commented on a change in pull request #9143:
URL: https://github.com/apache/airflow/pull/9143#discussion_r435841250
##########
File path: docs/howto/operator/bash.rst
##########
@@ -41,6 +41,37 @@ You can use :ref:`Jinja templates <jinja-templating>` to parameterize the
:start-after: [START howto_operator_bash_template]
:end-before: [END howto_operator_bash_template]
+
+.. warning::
+
+ Care should be taken with "user" input or when using Jinja templates in the
+ ``bash_command``, as this bash operator does not perform any escaping or
+ sanitization of the command.
+
+ This applies mostly to using "dag_run" conf, as that can be submitted via
+ users in the Web UI. Most of the default template variables are not at
+ risk.
+
+For example, do **not** do this:
+
+.. code-block:: python
+
+ bash_task = BashOperator(
+ task_id="bash_task",
+ bash_command='echo "Here is the message: \'{{ dag_run.conf["message"] if dag_run else "" }}\'"',
+ )
+
+Instead, you should pass this via the ``env`` kwarg and use double-quotes
+inside the bash_command, as below:
+
+.. code-block:: python
+
+ bash_task = BashOperator(
+ task_id="bash_task",
+ bash_command='echo "here is the message: \'$message\'"',
Review comment:
Oh pay attention ash. It's not this file.
----------------------------------------------------------------
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 #9143: Add note about using dag_run.conf in BashOperator
Posted by GitBox <gi...@apache.org>.
ashb commented on a change in pull request #9143:
URL: https://github.com/apache/airflow/pull/9143#discussion_r435844126
##########
File path: docs/howto/operator/bash.rst
##########
@@ -41,6 +41,37 @@ You can use :ref:`Jinja templates <jinja-templating>` to parameterize the
:start-after: [START howto_operator_bash_template]
:end-before: [END howto_operator_bash_template]
+
+.. warning::
+
+ Care should be taken with "user" input or when using Jinja templates in the
+ ``bash_command``, as this bash operator does not perform any escaping or
+ sanitization of the command.
+
+ This applies mostly to using "dag_run" conf, as that can be submitted via
+ users in the Web UI. Most of the default template variables are not at
+ risk.
+
+For example, do **not** do this:
+
+.. code-block:: python
+
+ bash_task = BashOperator(
+ task_id="bash_task",
+ bash_command='echo "Here is the message: \'{{ dag_run.conf["message"] if dag_run else "" }}\'"',
+ )
+
+Instead, you should pass this via the ``env`` kwarg and use double-quotes
+inside the bash_command, as below:
+
+.. code-block:: python
+
+ bash_task = BashOperator(
+ task_id="bash_task",
+ bash_command='echo "here is the message: \'$message\'"',
Review comment:
https://github.com/apache/airflow/pull/9143/commits/c8fd7de369dff5fcf9b5950b034330292f78062b
----------------------------------------------------------------
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 #9143: Add note about using dag_run.conf in BashOperator
Posted by GitBox <gi...@apache.org>.
ashb commented on pull request #9143:
URL: https://github.com/apache/airflow/pull/9143#issuecomment-639374456
(I tried with `\` first, that failed, and with `\\` too wondering if sphinx was treating `\\` as something. That failed too)
----------------------------------------------------------------
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 #9143: Add note about using dag_run.conf in BashOperator
Posted by GitBox <gi...@apache.org>.
ashb commented on a change in pull request #9143:
URL: https://github.com/apache/airflow/pull/9143#discussion_r435836054
##########
File path: docs/howto/operator/bash.rst
##########
@@ -41,6 +41,37 @@ You can use :ref:`Jinja templates <jinja-templating>` to parameterize the
:start-after: [START howto_operator_bash_template]
:end-before: [END howto_operator_bash_template]
+
+.. warning::
+
+ Care should be taken with "user" input or when using Jinja templates in the
+ ``bash_command``, as this bash operator does not perform any escaping or
+ sanitization of the command.
+
+ This applies mostly to using "dag_run" conf, as that can be submitted via
+ users in the Web UI. Most of the default template variables are not at
+ risk.
+
+For example, do **not** do this:
+
+.. code-block:: python
+
+ bash_task = BashOperator(
+ task_id="bash_task",
+ bash_command='echo "Here is the message: \'{{ dag_run.conf["message"] if dag_run else "" }}\'"',
+ )
+
+Instead, you should pass this via the ``env`` kwarg and use double-quotes
+inside the bash_command, as below:
+
+.. code-block:: python
+
+ bash_task = BashOperator(
+ task_id="bash_task",
+ bash_command='echo "here is the message: \'$message\'"',
Review comment:
Running it locally, the problem does appear to be around `\`
----------------------------------------------------------------
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] kaxil commented on a change in pull request #9143: Add note about using dag_run.conf in BashOperator
Posted by GitBox <gi...@apache.org>.
kaxil commented on a change in pull request #9143:
URL: https://github.com/apache/airflow/pull/9143#discussion_r435829790
##########
File path: docs/howto/operator/bash.rst
##########
@@ -41,6 +41,37 @@ You can use :ref:`Jinja templates <jinja-templating>` to parameterize the
:start-after: [START howto_operator_bash_template]
:end-before: [END howto_operator_bash_template]
+
+.. warning::
+
+ Care should be taken with "user" input or when using Jinja templates in the
+ ``bash_command``, as this bash operator does not perform any escaping or
+ sanitization of the command.
+
+ This applies mostly to using "dag_run" conf, as that can be submitted via
+ users in the Web UI. Most of the default template variables are not at
+ risk.
+
+For example, do **not** do this:
+
+.. code-block:: python
+
+ bash_task = BashOperator(
+ task_id="bash_task",
+ bash_command='echo "Here is the message: \'{{ dag_run.conf["message"] if dag_run else "" }}\'"',
+ )
+
+Instead, you should pass this via the ``env`` kwarg and use double-quotes
+inside the bash_command, as below:
+
+.. code-block:: python
+
+ bash_task = BashOperator(
+ task_id="bash_task",
+ bash_command='echo "here is the message: \'$message\'"',
Review comment:
This lin failed again, I mean you can remove the quotes after echo as it is just bash.
Example:
```suggestion
bash_command='echo here is the message: '$message"',
```
----------------------------------------------------------------
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 #9143: Add note about using dag_run.conf in BashOperator
Posted by GitBox <gi...@apache.org>.
ashb merged pull request #9143:
URL: https://github.com/apache/airflow/pull/9143
----------------------------------------------------------------
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 #9143: Add note about using dag_run.conf in BashOperator
Posted by GitBox <gi...@apache.org>.
ashb commented on a change in pull request #9143:
URL: https://github.com/apache/airflow/pull/9143#discussion_r435834967
##########
File path: docs/howto/operator/bash.rst
##########
@@ -41,6 +41,37 @@ You can use :ref:`Jinja templates <jinja-templating>` to parameterize the
:start-after: [START howto_operator_bash_template]
:end-before: [END howto_operator_bash_template]
+
+.. warning::
+
+ Care should be taken with "user" input or when using Jinja templates in the
+ ``bash_command``, as this bash operator does not perform any escaping or
+ sanitization of the command.
+
+ This applies mostly to using "dag_run" conf, as that can be submitted via
+ users in the Web UI. Most of the default template variables are not at
+ risk.
+
+For example, do **not** do this:
+
+.. code-block:: python
+
+ bash_task = BashOperator(
+ task_id="bash_task",
+ bash_command='echo "Here is the message: \'{{ dag_run.conf["message"] if dag_run else "" }}\'"',
+ )
+
+Instead, you should pass this via the ``env`` kwarg and use double-quotes
+inside the bash_command, as below:
+
+.. code-block:: python
+
+ bash_task = BashOperator(
+ task_id="bash_task",
+ bash_command='echo "here is the message: \'$message\'"',
Review comment:
I guess I can. The point was to try and get output when run like
> here is the message 'foo bar'
----------------------------------------------------------------
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 #9143: Add note about using dag_run.conf in BashOperator
Posted by GitBox <gi...@apache.org>.
ashb commented on pull request #9143:
URL: https://github.com/apache/airflow/pull/9143#issuecomment-639374043
Hmmmm, I wonder what is going on between sphinx and pygmentize:
```
airflow ❯ pygmentize -l python -F raiseonerror < test-lex.py
bash_task = BashOperator(
task_id="bash_task",
bash_command='echo "here is the message: \'$message\'"',
env={'message': '{{ dag_run.conf["message"] if dag_run else "" }}'},
```
works fine and doesn't error.
----------------------------------------------------------------
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] kaxil commented on a change in pull request #9143: Add note about using dag_run.conf in BashOperator
Posted by GitBox <gi...@apache.org>.
kaxil commented on a change in pull request #9143:
URL: https://github.com/apache/airflow/pull/9143#discussion_r435829790
##########
File path: docs/howto/operator/bash.rst
##########
@@ -41,6 +41,37 @@ You can use :ref:`Jinja templates <jinja-templating>` to parameterize the
:start-after: [START howto_operator_bash_template]
:end-before: [END howto_operator_bash_template]
+
+.. warning::
+
+ Care should be taken with "user" input or when using Jinja templates in the
+ ``bash_command``, as this bash operator does not perform any escaping or
+ sanitization of the command.
+
+ This applies mostly to using "dag_run" conf, as that can be submitted via
+ users in the Web UI. Most of the default template variables are not at
+ risk.
+
+For example, do **not** do this:
+
+.. code-block:: python
+
+ bash_task = BashOperator(
+ task_id="bash_task",
+ bash_command='echo "Here is the message: \'{{ dag_run.conf["message"] if dag_run else "" }}\'"',
+ )
+
+Instead, you should pass this via the ``env`` kwarg and use double-quotes
+inside the bash_command, as below:
+
+.. code-block:: python
+
+ bash_task = BashOperator(
+ task_id="bash_task",
+ bash_command='echo "here is the message: \'$message\'"',
Review comment:
This lin failed again, I mean you can remove the quotes after echo as it is just bash.
Example:
```suggestion
bash_command='echo here is the message: "$message"',
```
----------------------------------------------------------------
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