Skip to content

Validate subscriptions

Scheduled task that runs a validation workflow for all active subscriptions.

The list of workflows that should be executed is determined by multiple criteria. First, this task gathers a list of all active subscriptions that are in sync. For each subscription, the list of workflows attached to its product is fetched. From this list, each workflow is selected that meets the following: * The target of the workflow is SYSTEM. * The name of the workflow follows the pattern validate_*.

validate_subscriptions()

Validate all subscriptions using their corresponding validation workflow.

Validation workflows only run on subscriptions that are active, even when they could be run on provisioning subscriptions. E.g. for routers, they can manually be validated when provisioning, but are not included in this schedule.

Validation workflows will, in principle, only run on subscriptions that are in sync. Except when a specific validation workflow is marked as usable while out of sync in the list WF_USABLE_WHILE_OUT_OF_SYNC.

Source code in gso/schedules/validate_subscriptions.py 
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
@shared_task
@scheduler(CronScheduleConfig(name="Subscriptions Validator", minute="10", hour="3"))
def validate_subscriptions() -> None:
    """Validate all subscriptions using their corresponding validation workflow.

    Validation workflows only run on subscriptions that are active, even when they could be run on provisioning
    subscriptions. E.g. for routers, they can manually be validated when provisioning, but are not included in this
    schedule.

    Validation workflows will, in principle, only run on subscriptions that are in sync. Except when a specific
    validation workflow is marked as usable while out of sync in the list `WF_USABLE_WHILE_OUT_OF_SYNC`.
    """
    subscriptions = get_active_subscriptions()
    if not subscriptions:
        logger.info("No subscriptions to validate")
        return

    for subscription in subscriptions:
        if re.search(r"SKIP VALIDATION: .+", subscription.note or ""):
            #  The subscription is marked to skip validation altogether. We continue to the next subscription.
            logger.warning(
                "Manually skipped validation workflows for a subscription.",
                product=subscription.product.name,
                subscription_id=subscription.subscription_id,
                subscription_description=subscription.description,
                skip_reason=subscription.note,
            )
            continue

        found_a_validation_workflow = False
        for workflow in subscription.product.workflows:
            if workflow.target == Target.SYSTEM and workflow.name.startswith("validate_"):
                validation_workflow = workflow.name
                found_a_validation_workflow = True
                validation_workflow_usable = (subscription.status in TARGET_DEFAULT_USABLE_MAP[Target.SYSTEM]) and (
                    subscription.insync or (validation_workflow in WF_USABLE_WHILE_OUT_OF_SYNC)
                )

                if validation_workflow_usable:
                    logger.info(
                        "Found a usable validation workflow, scheduling task.",
                        product=subscription.product.name,
                        subscription_id=subscription.subscription_id,
                        subscription_description=subscription.description,
                        workflow=validation_workflow,
                    )

                    json = [{"subscription_id": str(subscription.subscription_id)}]
                    validate_func = get_execution_context()["validate"]
                    validate_func(validation_workflow, json=json)

                else:
                    logger.info(
                        "Validation workflow is not usable on this subscription instance",
                        product=subscription.product.name,
                        subscription_id=subscription.subscription_id,
                        subscription_description=subscription.description,
                        status=subscription.status,
                        insync=subscription.insync,
                        workflow=validation_workflow,
                    )

        if not found_a_validation_workflow:
            logger.warning(
                "SubscriptionTable has no validation workflow",
                product=subscription.product.name,
                subscription_id=subscription.subscription_id,
                subscription_description=subscription.description,
            )