|
| 1 | +# Generated by Django 4.2.16 on 2024-11-01 12:40 |
| 2 | + |
| 3 | +from django.db import migrations, models |
| 4 | +from aboutcode.pipeline import LoopProgress |
| 5 | + |
| 6 | + |
| 7 | +class Migration(migrations.Migration): |
| 8 | + """ |
| 9 | + Add url field to the VulnerabilitySeverity model and remove reference foreignkey |
| 10 | + relationship. Also, add new M2M 'severities' field in Vulnerability and |
| 11 | + AffectedByPackageRelatedVulnerability relationship. |
| 12 | +
|
| 13 | + To achieve this following model changes and data migrations are applied in chronological order: |
| 14 | + - Make VulnerabilitySeverity reference field nullable (to make the migration reversible). |
| 15 | + - Add 'severities' field to AffectedByPackageRelatedVulnerability. |
| 16 | + - Add 'severities' field to Vulnerability. |
| 17 | + - Add 'url' field to VulnerabilitySeverity. |
| 18 | + - Data migration to remove corrupted SUSE scores. |
| 19 | + - Data migration to populate new VulnerabilitySeverity url field using reference. |
| 20 | + - Data migration to populate Vulnerability 'severities' M2M relationship. |
| 21 | + - Delete VulnerabilitySeverity reference field. |
| 22 | + """ |
| 23 | + def remove_inaccurate_suse_score(apps, schema_editor): |
| 24 | + """ |
| 25 | + Remove inaccurate suse severity scores. |
| 26 | + See https://github.com/aboutcode-org/vulnerablecode/issues/1597 |
| 27 | + """ |
| 28 | + print(f"\nRemoving inaccurate suse severity scores.") |
| 29 | + VulnerabilitySeverity = apps.get_model("vulnerabilities", "VulnerabilitySeverity") |
| 30 | + VulnerabilitySeverity.objects.filter( |
| 31 | + reference__url="https://ftp.suse.com/pub/projects/security/yaml/suse-cvss-scores.yaml" |
| 32 | + ).delete() |
| 33 | + |
| 34 | + def reverse_remove_inaccurate_suse_score(apps, schema_editor): |
| 35 | + """Reverse data migration not needed for inaccurate severity scores.""" |
| 36 | + pass |
| 37 | + |
| 38 | + def populate_severity_model_with_url(apps, schema_editor): |
| 39 | + """Populate the new VulnerabilitySeverity `url` field using reference url""" |
| 40 | + |
| 41 | + VulnerabilitySeverity = apps.get_model("vulnerabilities", "VulnerabilitySeverity") |
| 42 | + chunk_size = 10000 |
| 43 | + batch = [] |
| 44 | + vulnerability_severity_query = VulnerabilitySeverity.objects.select_related("reference") |
| 45 | + |
| 46 | + print( |
| 47 | + f"\nPopulating {vulnerability_severity_query.count():,d} VulnerabilitySeverity" |
| 48 | + "`url` field using reference url." |
| 49 | + ) |
| 50 | + progress = LoopProgress( |
| 51 | + total_iterations=vulnerability_severity_query.count(), |
| 52 | + progress_step=10, |
| 53 | + logger=print, |
| 54 | + ) |
| 55 | + for severity in progress.iter(vulnerability_severity_query.iterator(chunk_size=chunk_size)): |
| 56 | + severity.url = severity.reference.url |
| 57 | + batch.append(severity) |
| 58 | + |
| 59 | + if len(batch) >= chunk_size: |
| 60 | + VulnerabilitySeverity.objects.bulk_update( |
| 61 | + objs=batch, |
| 62 | + fields=["url"], |
| 63 | + ) |
| 64 | + batch.clear() |
| 65 | + |
| 66 | + VulnerabilitySeverity.objects.bulk_update( |
| 67 | + objs=batch, |
| 68 | + fields=["url"], |
| 69 | + ) |
| 70 | + |
| 71 | + def reverse_populate_severity_model_reference_using_url(apps, schema_editor): |
| 72 | + """Reverse: Populate the reference using `url` to ensure proper reverse migration.""" |
| 73 | + VulnerabilitySeverity = apps.get_model("vulnerabilities", "VulnerabilitySeverity") |
| 74 | + VulnerabilityReference = apps.get_model("vulnerabilities", "VulnerabilityReference") |
| 75 | + chunk_size = 10000 |
| 76 | + batch = [] |
| 77 | + vulnerability_severity_query = VulnerabilitySeverity.objects.select_related("reference") |
| 78 | + |
| 79 | + print( |
| 80 | + f"\nReverse: Populating {vulnerability_severity_query.count():,d} VulnerabilitySeverity" |
| 81 | + "`reference` relation using url." |
| 82 | + ) |
| 83 | + progress = LoopProgress( |
| 84 | + total_iterations=vulnerability_severity_query.count(), |
| 85 | + progress_step=10, |
| 86 | + logger=print, |
| 87 | + ) |
| 88 | + for severity in progress.iter(vulnerability_severity_query.iterator(chunk_size=chunk_size)): |
| 89 | + severity.reference = VulnerabilityReference.objects.get(url=severity.url) |
| 90 | + batch.append(severity) |
| 91 | + |
| 92 | + if len(batch) >= chunk_size: |
| 93 | + VulnerabilitySeverity.objects.bulk_update( |
| 94 | + objs=batch, |
| 95 | + fields=["reference"], |
| 96 | + ) |
| 97 | + batch.clear() |
| 98 | + |
| 99 | + VulnerabilitySeverity.objects.bulk_update( |
| 100 | + objs=batch, |
| 101 | + fields=["reference"], |
| 102 | + ) |
| 103 | + |
| 104 | + def populate_vulnerability_model_with_severities(apps, schema_editor): |
| 105 | + """Populate the new Vulnerability `severities` relation using referenced severity.""" |
| 106 | + Vulnerability = apps.get_model("vulnerabilities", "Vulnerability") |
| 107 | + chunk_size = 10000 |
| 108 | + |
| 109 | + vulnerability_query = Vulnerability.objects.prefetch_related( |
| 110 | + "references__vulnerabilityseverity_set" |
| 111 | + ) |
| 112 | + print( |
| 113 | + f"\nPopulating {vulnerability_query.count():,d} Vulnerability `severities`" |
| 114 | + "relation using referenced severity." |
| 115 | + ) |
| 116 | + progress = LoopProgress( |
| 117 | + total_iterations=vulnerability_query.count(), |
| 118 | + progress_step=10, |
| 119 | + logger=print, |
| 120 | + ) |
| 121 | + for vulnerability in progress.iter(vulnerability_query.iterator(chunk_size=chunk_size)): |
| 122 | + references = vulnerability.references.all() |
| 123 | + severity_ids = [ |
| 124 | + severity.id |
| 125 | + for reference in references |
| 126 | + for severity in reference.vulnerabilityseverity_set.all() |
| 127 | + if reference.vulnerabilityseverity_set.exists() |
| 128 | + ] |
| 129 | + vulnerability.severities.set(severity_ids) |
| 130 | + |
| 131 | + def reverse_populate_vulnerability_model_with_severities(apps, schema_editor): |
| 132 | + """Reverse data migration not needed for new `severities` relationship.""" |
| 133 | + pass |
| 134 | + |
| 135 | + dependencies = [ |
| 136 | + ("vulnerabilities", "0074_update_pysec_advisory_created_by"), |
| 137 | + ] |
| 138 | + |
| 139 | + operations = [ |
| 140 | + # reference field should nullable to properly support reverse migration. |
| 141 | + migrations.AlterField( |
| 142 | + model_name="vulnerabilityseverity", |
| 143 | + name="reference", |
| 144 | + field=models.ForeignKey( |
| 145 | + to="vulnerabilities.vulnerabilityreference", |
| 146 | + on_delete=models.CASCADE, |
| 147 | + null=True, |
| 148 | + ), |
| 149 | + ), |
| 150 | + migrations.AlterModelOptions( |
| 151 | + name="vulnerabilityseverity", |
| 152 | + options={"ordering": ["url", "scoring_system", "value"]}, |
| 153 | + ), |
| 154 | + migrations.AlterUniqueTogether( |
| 155 | + name="vulnerabilityseverity", |
| 156 | + unique_together=set(), |
| 157 | + ), |
| 158 | + migrations.AddField( |
| 159 | + model_name="affectedbypackagerelatedvulnerability", |
| 160 | + name="severities", |
| 161 | + field=models.ManyToManyField( |
| 162 | + related_name="affected_package_vulnerability_relations", |
| 163 | + to="vulnerabilities.vulnerabilityseverity", |
| 164 | + ), |
| 165 | + ), |
| 166 | + migrations.AddField( |
| 167 | + model_name="vulnerability", |
| 168 | + name="severities", |
| 169 | + field=models.ManyToManyField( |
| 170 | + related_name="vulnerabilities", to="vulnerabilities.vulnerabilityseverity" |
| 171 | + ), |
| 172 | + ), |
| 173 | + migrations.AddField( |
| 174 | + model_name="vulnerabilityseverity", |
| 175 | + name="url", |
| 176 | + field=models.URLField( |
| 177 | + help_text="URL to the vulnerability severity", max_length=1024, null=True |
| 178 | + ), |
| 179 | + ), |
| 180 | + migrations.RunPython( |
| 181 | + code=remove_inaccurate_suse_score, |
| 182 | + reverse_code=reverse_remove_inaccurate_suse_score, |
| 183 | + ), |
| 184 | + migrations.RunPython( |
| 185 | + code=populate_severity_model_with_url, |
| 186 | + reverse_code=reverse_populate_severity_model_reference_using_url, |
| 187 | + ), |
| 188 | + migrations.RunPython( |
| 189 | + code=populate_vulnerability_model_with_severities, |
| 190 | + reverse_code=reverse_populate_vulnerability_model_with_severities, |
| 191 | + ), |
| 192 | + migrations.RemoveField( |
| 193 | + model_name="vulnerabilityseverity", |
| 194 | + name="reference", |
| 195 | + ), |
| 196 | + ] |
0 commit comments