[jira] [Commented] (AIRFLOW-5644) Simplify TriggerDagRunOperator usage

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

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

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

BasPH commented on pull request #6317: [AIRFLOW-5644] Simplify TriggerDagRunOperator usage
URL: https://github.com/apache/airflow/pull/6317
 
 
   Make sure you have checked _all_ steps below.
   
   ### Jira
   
   - [x] 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-5644
     - 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.
     - In case you are proposing a fundamental code change, you need to create an Airflow Improvement Proposal ([AIP](https://cwiki.apache.org/confluence/display/AIRFLOW/Airflow+Improvements+Proposals)).
     - In case you are adding a dependency, check if the license complies with the [ASF 3rd Party License Policy](https://www.apache.org/legal/resolved.html#category-x).
   
   ### Description
   
   - [x] Here are some details about my PR, including screenshots of any UI changes:
   
   This PR refactors the TriggerDagRunOperator to provide a much more intuitive behaviour, i.e. it now has a `conf` argument to which a dict can be provided, for configuration for the triggered Dag(Run).
   
   Before:
   
   ```python
   def _trigger_task(context, object):
       object.payload = {"message": "Hello world"}
       return object
   
   trigger_task = TriggerDagRunOperator(
       task_id='test_trigger_dagrun',
       trigger_dag_id="example_trigger_target_dag",
       python_callable=_trigger_task,
       dag=dag,
   )
   ```
   
   After:
   
   ```python
   trigger_task = TriggerDagRunOperator(
       task_id='test_trigger_dagrun',
       trigger_dag_id="example_trigger_target_dag",
       conf={"message": "Hello world"},
       dag=dag,
   )
   ```
   
   ### Tests
   
   - [x] My PR adds the following unit tests __OR__ does not need testing for this extremely good reason:
   
   TriggerDagRunOperator tests were extracted from core.py and placed in a dedicated test_dagrun_operator.py file. I added additional tests for validating correct behaviour.
   
   These tests were a bit tricky because they rely on passing state via the database. To make these idempotent and not rely on external files (i.e. example DAGs), the `setUp()` writes a small DAG to a temporary file, which is used throughout the tests, and in the `tearDown()` all state is removed from the DB.
   
   ### 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.
     - All the public functions and the classes in the PR contain docstrings that explain what it does
     - If you implement backwards incompatible changes, please leave a note in the [Updating.md](https://github.com/apache/airflow/blob/master/UPDATING.md) so we can assign it to a appropriate release
   
 
----------------------------------------------------------------
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


> Simplify TriggerDagRunOperator usage
> ------------------------------------
>
>                 Key: AIRFLOW-5644
>                 URL: https://issues.apache.org/jira/browse/AIRFLOW-5644
>             Project: Apache Airflow
>          Issue Type: Improvement
>          Components: operators
>    Affects Versions: 2.0.0
>            Reporter: Bas Harenslak
>            Priority: Major
>
> The TriggerDagRunOperator usage is rather odd at the moment, especially the way to pass a conf.



--
This message was sent by Atlassian Jira
(v8.3.4#803005)