feat: Create plans and tiers tables (#467)

* first pass to the plans and tiers tables

* remove comments

* fix linting

* resolve comments

* update with migration

* update with correct name

* create factories

* add app-label back

* update name of tables

---------

Co-authored-by: Ajay Singh <[email protected]>

Author: RulaKhaled

shared/django_apps/codecov_auth/migrations/0063_tier_plan.py

@@ -0,0 +1,91 @@
+# Generated by Django 4.2.16 on 2025-01-14 18:09
+
+import django.contrib.postgres.fields
+import django.db.models.deletion
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    """
+    BEGIN;
+    --
+    -- Create model Tier
+    --
+    CREATE TABLE "codecov_auth_tier" ("id" bigint NOT NULL PRIMARY KEY GENERATED BY DEFAULT AS IDENTITY, "created_at" timestamp with time zone NOT NULL, "updated_at" timestamp with time zone NOT NULL, "tier_name" varchar(255) NOT NULL UNIQUE, "bundle_analysis" boolean NOT NULL, "test_analytics" boolean NOT NULL, "flaky_test_detection" boolean NOT NULL, "project_coverage" boolean NOT NULL, "private_repo_support" boolean NOT NULL);
+    --
+    -- Create model Plan
+    --
+    CREATE TABLE "codecov_auth_plan" ("id" bigint NOT NULL PRIMARY KEY GENERATED BY DEFAULT AS IDENTITY, "created_at" timestamp with time zone NOT NULL, "updated_at" timestamp with time zone NOT NULL, "base_unit_price" integer NOT NULL, "benefits" text[] NOT NULL, "billing_rate" text NULL, "is_active" boolean NOT NULL, "marketing_name" varchar(255) NOT NULL, "max_seats" integer NULL, "monthly_uploads_limit" integer NULL, "paid_plan" boolean NOT NULL, "name" varchar(255) NOT NULL UNIQUE, "tier_id" bigint NOT NULL);
+    CREATE INDEX "codecov_auth_tier_tier_name_ec8e98b1_like" ON "codecov_auth_tier" ("tier_name" varchar_pattern_ops);
+    ALTER TABLE "codecov_auth_plan" ADD CONSTRAINT "codecov_auth_plan_tier_id_7847a9eb_fk_codecov_auth_tier_id" FOREIGN KEY ("tier_id") REFERENCES "codecov_auth_tier" ("id") DEFERRABLE INITIALLY DEFERRED;
+    CREATE INDEX "codecov_auth_plan_name_e2fccac6_like" ON "codecov_auth_plan" ("name" varchar_pattern_ops);
+    CREATE INDEX "codecov_auth_plan_tier_id_7847a9eb" ON "codecov_auth_plan" ("tier_id");
+    COMMIT;
+    """
+
+    dependencies = [
+        ("codecov_auth", "0062_alter_owner_upload_token_required_for_public_repos"),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name="Tier",
+            fields=[
+                ("id", models.BigAutoField(primary_key=True, serialize=False)),
+                ("created_at", models.DateTimeField(auto_now_add=True)),
+                ("updated_at", models.DateTimeField(auto_now=True)),
+                ("tier_name", models.CharField(max_length=255, unique=True)),
+                ("bundle_analysis", models.BooleanField(default=False)),
+                ("test_analytics", models.BooleanField(default=False)),
+                ("flaky_test_detection", models.BooleanField(default=False)),
+                ("project_coverage", models.BooleanField(default=False)),
+                ("private_repo_support", models.BooleanField(default=False)),
+            ],
+            options={
+                "abstract": False,
+            },
+        ),
+        migrations.CreateModel(
+            name="Plan",
+            fields=[
+                ("id", models.BigAutoField(primary_key=True, serialize=False)),
+                ("created_at", models.DateTimeField(auto_now_add=True)),
+                ("updated_at", models.DateTimeField(auto_now=True)),
+                ("base_unit_price", models.IntegerField(blank=True, default=0)),
+                (
+                    "benefits",
+                    django.contrib.postgres.fields.ArrayField(
+                        base_field=models.TextField(),
+                        blank=True,
+                        default=list,
+                        size=None,
+                    ),
+                ),
+                (
+                    "billing_rate",
+                    models.TextField(
+                        blank=True,
+                        choices=[("monthly", "Monthly"), ("annually", "Annually")],
+                        null=True,
+                    ),
+                ),
+                ("is_active", models.BooleanField(default=True)),
+                ("marketing_name", models.CharField(max_length=255)),
+                ("max_seats", models.IntegerField(blank=True, null=True)),
+                ("monthly_uploads_limit", models.IntegerField(blank=True, null=True)),
+                ("paid_plan", models.BooleanField(default=False)),
+                ("name", models.CharField(max_length=255, unique=True)),
+                (
+                    "tier",
+                    models.ForeignKey(
+                        on_delete=django.db.models.deletion.CASCADE,
+                        related_name="plans",
+                        to="codecov_auth.tier",
+                    ),
+                ),
+            ],
+            options={
+                "abstract": False,
+            },
+        ),
+    ]

shared/django_apps/codecov_auth/models.py

@@ -997,3 +997,46 @@ def save(self, *args, **kwargs):
                 id=self.id
             ).update(is_active=False)
         return super().save(*args, **kwargs)
+
+
+class BillingRate(models.TextChoices):
+    MONTHLY = "monthly"
+    ANNUALLY = "annually"
+
+
+class Plan(BaseModel):
+    tier = models.ForeignKey("Tier", on_delete=models.CASCADE, related_name="plans")
+    base_unit_price = models.IntegerField(default=0, blank=True)
+    benefits = ArrayField(models.TextField(), blank=True, default=list)
+    billing_rate = models.TextField(
+        choices=BillingRate.choices,
+        null=True,
+        blank=True,
+    )
+    is_active = models.BooleanField(default=True)
+    marketing_name = models.CharField(max_length=255)
+    max_seats = models.IntegerField(null=True, blank=True)
+    monthly_uploads_limit = models.IntegerField(null=True, blank=True)
+    paid_plan = models.BooleanField(default=False)
+    name = models.CharField(max_length=255, unique=True)
+
+    class Meta:
+        app_label = CODECOV_AUTH_APP_LABEL
+
+    def __str__(self):
+        return self.name
+
+
+class Tier(BaseModel):
+    tier_name = models.CharField(max_length=255, unique=True)
+    bundle_analysis = models.BooleanField(default=False)
+    test_analytics = models.BooleanField(default=False)
+    flaky_test_detection = models.BooleanField(default=False)
+    project_coverage = models.BooleanField(default=False)
+    private_repo_support = models.BooleanField(default=False)
+
+    class Meta:
+        app_label = CODECOV_AUTH_APP_LABEL
+
+    def __str__(self):
+        return self.tier_name

shared/django_apps/codecov_auth/tests/factories.py

@@ -13,9 +13,11 @@
     OrganizationLevelToken,
     Owner,
     OwnerProfile,
+    Plan,
     SentryUser,
     Session,
     StripeBilling,
+    Tier,
     TokenTypeChoices,
     User,
     UserToken,
@@ -169,3 +171,26 @@ class Meta:
         model = InvoiceBilling
 
     account = factory.SubFactory(Account)
+
+
+class TierFactory(DjangoModelFactory):
+    class Meta:
+        model = Tier
+
+    tier_name = factory.Faker("name")
+
+
+class PlanFactory(DjangoModelFactory):
+    class Meta:
+        model = Plan
+
+    base_unit_price = factory.Faker("pyint")
+    benefits = []
+    billing_rate = None
+    is_active = True
+    marketing_name = factory.Faker("name")
+    max_seats = None
+    monthly_uploads_limit = None
+    paid_plan = True
+    name = factory.Faker("name")
+    tier = factory.SubFactory(TierFactory)