Feat: Django Command run on startup to add plans / tiers

[ajay-sentry]

Purpose/Motivation

This PR aims to make it dead simple to integrate the new plans into the Codecov local development environment, and provide a bridge for self-hosted folks as well.

This is done through a new django command which can currently be run with a "tier" or "plan" flag in the form of

python manage.py insert_data_to_db_from_csv nameOfCSV --model plans (or tiers)

You can use the provided csvs that are in the same directory or your own CSV if you so choose. The CSVs that are in the codebase are the "current" plan and tier information for codecov. I was originally thinking we should obfuscate this stuff... but for now it doesn't really make sense to do that because it's all public information anyway lol

Anyway, on app start, both the tier and plan version of this command are run if you're on the dev environment. Assuming umbrella-hat is the default way for folks to run the app I figure this is probably going to provide an experience where no "breaking changes" are felt though they are present.

Links to relevant tickets

Epic: codecov/engineering-team#2778

Closes codecov/engineering-team#3286

What does this PR do?

Include a brief description of the changes in this PR. Bullet points are your friend.

Notes to Reviewer

Anything to note to the team? Any tips on how to review, or where to start?

Legal Boilerplate

Look, I get it. The entity doing business as "Sentry" was incorporated in the State of Delaware in 2015 as Functional Software, Inc. In 2022 this entity acquired Codecov and as result Sentry is going to need some rights from me in order to utilize my contributions in this PR. So here's the deal: I retain all rights, title and interest in and to my contributions, and by keeping this boilerplate intact I confirm that Sentry can use, modify, copy, and redistribute my contributions, under Sentry's choice of terms.

[codecov-staging]

Codecov Report

Attention: Patch coverage is 85.10638% with 7 lines in your changes missing coverage. Please review.

✅ All tests successful. No failed tests found.

Files with missing lines	Patch %	Lines
.../management/commands/insert_data_to_db_from_csv.py	84.21%	6 Missing ⚠️
core/apps.py	88.88%	1 Missing ⚠️

📢 Thoughts on this report? Let us know!

[github-actions]

✅ All tests successful. No failed tests were found.

📣 Thoughts on this report? Let Codecov know! | Powered by Codecov

[codecov-public-qa]

❌ 1 Tests Failed:

Tests completed	Failed	Passed	Skipped
2713	1	2712	6

View the top 1 failed tests by shortest run time

core/tests/test_management_commands.py::::test_insert_data_to_db_from_csv_for_plans

Stack Traces | 0.013s run time

@pytest.mark.django_db
    def test_insert_data_to_db_from_csv_for_plans():
        # Create a temporary CSV file
        with tempfile.NamedTemporaryFile(mode="w", delete=False, newline="") as temp_csv:
            writer = csv.writer(temp_csv)
            writer.writerow(
                ["name", "marketing_name", "base_unit_price", "tier_id", "is_active"]
            )
            writer.writerow(["Plan A", "Marketing A", "100", "1", "true"])
            writer.writerow(["Plan B", "Marketing B", "200", "2", "false"])
            csv_path = temp_csv.name
    
        Tier.objects.create(tier_name="Tier 1")
        Tier.objects.create(tier_name="Tier 2")
    
        out = StringIO()
        call_command("insert_data_to_db_from_csv", csv_path, "--model", "plans", stdout=out)
    
        # Check the output
        assert "Successfully inserted all data into plans from CSV" in out.getvalue()
    
        print(Plan.objects.all())
        print(Tier.objects.all())
        print(Plan.objects.filter(name="Plan A").exists())
        print(Plan.objects.filter(name="Plan B").exists())
    
        # Verify the data was inserted correctly
>       assert Plan.objects.filter(name="Plan A").exists()
E       AssertionError: assert False
E        +  where False = <bound method QuerySet.exists of <QuerySet []>>()
E        +    where <bound method QuerySet.exists of <QuerySet []>> = <QuerySet []>.exists
E        +      where <QuerySet []> = <bound method QuerySet.filter of <django.db.models.manager.Manager object at 0x7f68b84b4980>>(name='Plan A')
E        +        where <bound method QuerySet.filter of <django.db.models.manager.Manager object at 0x7f68b84b4980>> = <django.db.models.manager.Manager object at 0x7f68b84b4980>.filter
E        +          where <django.db.models.manager.Manager object at 0x7f68b84b4980> = Plan.objects

core/tests/test_management_commands.py:157: AssertionError

To view more test analytics, go to the Test Analytics Dashboard
📢 Thoughts on this report? Let us know!

[codecov-qa]

Codecov Report

Attention: Patch coverage is 85.10638% with 7 lines in your changes missing coverage. Please review.

Project coverage is 96.00%. Comparing base (e06c5d8) to head (97a3b39).
Report is 1 commits behind head on main.

✅ All tests successful. No failed tests found.

[ajay-sentry]

Jan 25 corresponds to January 2025

[adrian-codecov]

🖨️

[ajay-sentry]

was debugging the failing test 😅, fixed!

[adrian-codecov]

Remind me, what's the plan to seed prod then?

[ajay-sentry]

already seeded via Django Admin, and will be kept up to date there as well

[RulaKhaled]

sentryy unit price should be 10

[ajay-sentry]

I might be missing something, I believe that's the case already :O

But I think you're right about pro plan being off users-pr-inappy having the incorrect price

[sentry]

Suspect Issues

This pull request was deployed and Sentry observed the following issues:

• ‼️ IntegrityError: duplicate key value violates unique constraint "codecov_auth_tier_pkey" core.management.commands.insert_data_to_db_from... View Issue

_{Did you find this useful? React with a 👍 or 👎}