test: add Airflow 3 DAG versioning tests for Cosmos

[michal-mrazek]

Description

This PR adds a test for Airflow 3 versioning. We verify that adding a model to DbtDag will change a dag version.

Related Issue(s)

#2131

Breaking Change?

Checklist

• I have made corresponding changes to the documentation (if required)
• I have added tests that prove my fix is effective or that my feature works

[Copilot]

Pull request overview

This PR adds integration tests for Airflow 3's DAG versioning system to verify that Cosmos correctly handles version tracking when dbt models are added or when DAGs remain unchanged.

Key Changes:

• Added comprehensive test fixtures for DAG serialization, cleanup, and task instance creation
• Implemented two integration tests verifying version increment behavior with structural changes and version stability without modifications

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[pankajastro]

Thank you so much for the work on this PR — I really appreciate the effort! 🙌

One quick note: Cosmos handles DAG versioning a bit differently. For context, Cosmos added DAG-versioning support in this PR: #1907

It might be more aligned with the Cosmos approach to structure the test like:

• Create a DAG object
• Run the DAG using the helper here: https://github.com/astronomer/astronomer-cosmos/blob/main/tests/utils.py#L29
  and check the version with DagVersion.get_latest_version(...)
• Update the dbt project
• Run again and assert the version changes

Curious to hear what you think — happy to collaborate on the approach!

[michal-mrazek]

Thank you so much for the work on this PR — I really appreciate the effort! 🙌

One quick note: Cosmos handles DAG versioning a bit differently. For context, Cosmos added DAG-versioning support in this PR: #1907

It might be more aligned with the Cosmos approach to structure the test like:

• Create a DAG object
• Run the DAG using the helper here: https://github.com/astronomer/astronomer-cosmos/blob/main/tests/utils.py#L29
  and check the version with DagVersion.get_latest_version(...)
• Update the dbt project
• Run again and assert the version changes

Curious to hear what you think — happy to collaborate on the approach!

Thanks @pankajastro, I will adjust the PR 👍

[michal-mrazek]

@pankajastro I started using the run_dag() as you suggested. I also switched from jaffle shop to simple dbt project, since we are actually running it and I didn't want it to take ages :)

If you have any other suggestions, happy to include them :)

[pankajastro]

@pankajastro I started using the run_dag() as you suggested. I also switched from jaffle shop to simple dbt project, since we are actually running it and I didn't want it to take ages :)

If you have any other suggestions, happy to include them :)

Thanks for addressing it. We run jaffle_shop in many tests, so it may be ok to run it. I have one more feedback otherwise looking good

[netlify]

✅ Deploy Preview for astronomer-cosmos canceled.

Name	Link
🔨 Latest commit	13aba56
🔍 Latest deploy log	https://app.netlify.com/projects/astronomer-cosmos/deploys/697b8c0cdbfa770008bc588d

[pankajkoti]

Thanks for contributing this valuable PR @michal-mrazek

A few tests are failing in the CI. Would you be able to investigate those, please?

Also, issue #2131 mentions in point 2 to also add a test for "changes that should not lead to DAG change, no new version". Do you think we can add that test as well as part of this PR?

[michal-mrazek]

Hello @pankajkoti , hopefully I fixed the tests now :)

I did not find a scenarion when "changes that should not lead to DAG change, no new version". To by knowledge, all changes lead to a new version, or am I wrong here? :)

[tatiana]

@michal-mrazek, it feels we're really close to merging this PR. If you get a chance, please, fix the last failing checks. If we can do this before tomorrow, we can release it as part of 1.13.0, or we'll merge this after this release

[michal-mrazek]

@tatiana I am on it right now, so we can merge it today :)

[michal-mrazek]

I think the tests should pass now, if you can pls trigger it 🙏

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 98.12%. Comparing base (d04da62) to head (13aba56).
⚠️ Report is 2 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #2177   +/-   ##
=======================================
  Coverage   98.12%   98.12%           
=======================================
  Files         100      100           
  Lines        6719     6719           
=======================================
  Hits         6593     6593           
  Misses        126      126           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[tatiana]

Tests like this help us ensure Cosmos behaves as we expect. I know this PR went through many iterations and improvements. Thanks a lot @michal-mrazek for addressing each and every piece of feedback, and for your patience with our delays, and for bringing it to completion.