def test_generate_change_log_is_empty_when_no_change(self):
experiment = ExperimentFactory.create()
old_serialized_val = ChangeLogSerializer(experiment).data
new_serialized_val = ChangeLogSerializer(experiment).data
changed_data = {}
user = UserFactory.create()
generate_change_log(old_serialized_val, new_serialized_val, experiment,
changed_data, user)
changed_values = experiment.changes.latest().changed_values
self.assertEqual(changed_values, {})
def __init__(self, request, *args, **kwargs):
self.request = request
super().__init__(*args, **kwargs)
if self.instance.id:
self.old_serialized_vals = ChangeLogSerializer(self.instance).data
else:
self.old_serialized_vals = None
def update_experiment_with_change_log(old_experiment, changed_data):
old_serialized_exp = ChangeLogSerializer(old_experiment).data
Experiment.objects.filter(id=old_experiment.id).update(**changed_data)
new_experiment = Experiment.objects.get(slug=old_experiment.slug)
new_serialized_exp = ChangeLogSerializer(new_experiment).data
normandy_user = settings.NORMANDY_DEFAULT_CHANGELOG_USER
default_user, _ = get_user_model().objects.get_or_create(
email=normandy_user, username=normandy_user)
generate_change_log(
old_serialized_exp,
new_serialized_exp,
new_experiment,
changed_data,
default_user,
)
def update_changelog(self, instance, validated_data):
new_serialized_vals = ChangeLogSerializer(instance).data
user = self.context["request"].user
changed_data = validated_data.copy()
generate_change_log(self.old_serialized_vals, new_serialized_vals,
instance, changed_data, user)
return instance
def save(self, *args, **kwargs):
experiment = super().save(*args, **kwargs)
new_serialized_vals = ChangeLogSerializer(self.instance).data
message = self.get_changelog_message()
generate_change_log(
self.old_serialized_vals,
new_serialized_vals,
experiment,
self.changed_data,
self.request.user,
message,
self.fields,
)
return experiment
def test_serializer_outputs_expected_schema(self):
country1 = CountryFactory(code="CA", name="Canada")
locale1 = LocaleFactory(code="da", name="Danish")
project = ProjectFactory.create()
experiment = ExperimentFactory.create(
locales=[locale1], countries=[country1], projects=[project]
)
related_exp = ExperimentFactory.create()
experiment.related_to.add(related_exp)
serializer = ChangeLogSerializer(experiment)
risk_tech_description = experiment.risk_technical_description
expected_data = {
"type": experiment.type,
"owner": experiment.owner.id,
"name": experiment.name,
"short_description": experiment.short_description,
"related_work": experiment.related_work,
"related_to": [related_exp.id],
"proposed_start_date": str(experiment.proposed_start_date),
"proposed_duration": experiment.proposed_duration,
"proposed_enrollment": experiment.proposed_enrollment,
"design": experiment.design,
"addon_experiment_id": experiment.addon_experiment_id,
"addon_release_url": experiment.addon_release_url,
"pref_name": experiment.pref_name,
"pref_type": experiment.pref_type,
"pref_branch": experiment.pref_branch,
"public_name": experiment.public_name,
"public_description": experiment.public_description,
"population_percent": "{0:.4f}".format(experiment.population_percent),
"firefox_min_version": experiment.firefox_min_version,
"firefox_max_version": experiment.firefox_max_version,
"firefox_channel": experiment.firefox_channel,
"client_matching": experiment.client_matching,
"locales": [{"code": "da", "name": "Danish"}],
"countries": [{"code": "CA", "name": "Canada"}],
"projects": [{"slug": project.slug}],
"platforms": experiment.platforms,
"windows_versions": experiment.windows_versions,
"profile_age": experiment.profile_age,
"objectives": experiment.objectives,
"total_enrolled_clients": experiment.total_enrolled_clients,
"analysis": experiment.analysis,
"analysis_owner": experiment.analysis_owner.id,
"telemetry_event_category": experiment.telemetry_event_category,
"telemetry_event_method": experiment.telemetry_event_method,
"telemetry_event_object": experiment.telemetry_event_object,
"telemetry_event_value": experiment.telemetry_event_value,
"survey_required": experiment.survey_required,
"survey_urls": experiment.survey_urls,
"survey_instructions": experiment.survey_instructions,
"engineering_owner": experiment.engineering_owner,
"bugzilla_id": experiment.bugzilla_id,
"normandy_slug": experiment.normandy_slug,
"normandy_id": experiment.normandy_id,
"data_science_issue_url": experiment.data_science_issue_url,
"feature_bugzilla_url": experiment.feature_bugzilla_url,
"risk_partner_related": experiment.risk_partner_related,
"risk_brand": experiment.risk_brand,
"risk_fast_shipped": experiment.risk_fast_shipped,
"risk_confidential": experiment.risk_confidential,
"risk_release_population": experiment.risk_release_population,
"risk_revenue": experiment.risk_revenue,
"risk_data_category": experiment.risk_data_category,
"risk_external_team_impact": experiment.risk_external_team_impact,
"risk_telemetry_data": experiment.risk_telemetry_data,
"risk_ux": experiment.risk_ux,
"risk_security": experiment.risk_security,
"risk_revision": experiment.risk_revision,
"risk_technical": experiment.risk_technical,
"risk_technical_description": risk_tech_description,
"risks": experiment.risks,
"testing": experiment.testing,
"test_builds": experiment.test_builds,
"qa_status": experiment.qa_status,
"review_science": experiment.review_science,
"review_engineering": experiment.review_engineering,
"review_qa_requested": experiment.review_qa_requested,
"review_intent_to_ship": experiment.review_intent_to_ship,
"review_bugzilla": experiment.review_bugzilla,
"review_qa": experiment.review_qa,
"review_relman": experiment.review_relman,
"review_advisory": experiment.review_advisory,
"review_legal": experiment.review_legal,
"review_ux": experiment.review_ux,
"review_security": experiment.review_security,
"review_vp": experiment.review_vp,
"review_data_steward": experiment.review_data_steward,
"review_comms": experiment.review_comms,
"review_impacted_teams": experiment.review_impacted_teams,
"variants": [
{
"description": variant.description,
"is_control": variant.is_control,
"name": variant.name,
"ratio": variant.ratio,
"slug": variant.slug,
"value": variant.value,
"addon_release_url": variant.addon_release_url,
"preferences": [
{
"pref_name": preference.pref_name,
"pref_type": preference.pref_type,
"pref_branch": preference.pref_branch,
"pref_value": preference.pref_value,
}
for preference in variant.preferences.all()
],
"message_targeting": variant.message_targeting,
"message_threshold": variant.message_threshold,
"message_triggers": variant.message_triggers,
}
for variant in experiment.variants.all()
],
"results_url": experiment.results_url,
"results_initial": experiment.results_initial,
"results_lessons_learned": experiment.results_lessons_learned,
"results_fail_to_launch": experiment.results_fail_to_launch,
"results_recipe_errors": experiment.results_recipe_errors,
"results_restarts": experiment.results_restarts,
"results_low_enrollment": experiment.results_low_enrollment,
"results_early_end": experiment.results_early_end,
"results_no_usable_data": experiment.results_no_usable_data,
"results_failures_notes": experiment.results_failures_notes,
"results_changes_to_firefox": experiment.results_changes_to_firefox,
"results_data_for_hypothesis": experiment.results_data_for_hypothesis,
"results_confidence": experiment.results_confidence,
"results_measure_impact": experiment.results_measure_impact,
"results_impact_notes": experiment.results_impact_notes,
"rollout_playbook": experiment.rollout_playbook,
"rollout_type": experiment.rollout_type,
"message_type": experiment.message_type,
"message_template": experiment.message_template,
}
self.assertEqual(set(serializer.data.keys()), set(expected_data.keys()))
self.assertEqual(serializer.data, expected_data)
def test_generate_change_log_gives_correct_output(self):
experiment = ExperimentFactory.create_with_status(
target_status=Experiment.STATUS_REVIEW,
num_variants=0,
short_description="description",
qa_status="pretty good",
firefox_min_version="55.0",
)
variant1 = ExperimentVariantFactory.create(
experiment=experiment,
ratio=75,
description="variant1 description",
name="variant1",
slug="variant1-slug",
)
variant1.save()
old_serialized_val = ChangeLogSerializer(experiment).data
experiment.short_description = "changing the description"
experiment.qa_status = "good"
experiment.firefox_min_version = "56.0"
variant2 = ExperimentVariantFactory.create(
experiment=experiment,
ratio=25,
description="variant2 description",
name="variant2",
slug="variant2-slug",
)
variant2.save()
VariantPreferencesFactory.create(
variant=variant2,
pref_name="p1",
pref_type=Experiment.PREF_TYPE_INT,
pref_branch=Experiment.PREF_BRANCH_DEFAULT,
pref_value="5",
)
experiment.save()
new_serialized_val = ChangeLogSerializer(experiment).data
changed_variant_pref = {
"pref_name": "p1",
"pref_type": "integer",
"pref_branch": "default",
"pref_value": "5",
}
changed_data = {
"short_description":
"changing the description",
"qa_status":
"good",
"firefox_min_version":
"56.0",
"variants": [{
"ratio": 25,
"description": "variant2 description",
"name": "variant2",
"slug": "variant2-slug",
"preferences": [changed_variant_pref],
}],
}
user = UserFactory.create()
generate_change_log(old_serialized_val, new_serialized_val, experiment,
changed_data, user)
changed_value = experiment.changes.latest().changed_values
expected_changed_value = {
"firefox_min_version": {
"display_name": "Firefox Min Version",
"new_value": "56.0",
"old_value": "55.0",
},
"qa_status": {
"display_name": "Qa Status",
"new_value": "good",
"old_value": "pretty good",
},
"short_description": {
"display_name": "Short Description",
"new_value": "changing the description",
"old_value": "description",
},
"variants": {
"display_name":
"Branches",
"new_value": [
{
"ratio": 25,
"description": "variant2 description",
"name": "variant2",
"slug": "variant2-slug",
},
{
"ratio": 75,
"description": "variant1 description",
"name": "variant1",
"slug": "variant1-slug",
},
],
"old_value": [{
"ratio": 75,
"description": "variant1 description",
"name": "variant1",
"slug": "variant1-slug",
}],
},
}
self.assertEqual(
expected_changed_value["firefox_min_version"],
changed_value["firefox_min_version"],
)
self.assertEqual(expected_changed_value["qa_status"],
changed_value["qa_status"])
self.assertEqual(
expected_changed_value["short_description"],
changed_value["short_description"],
)
self.assertCountEqual(expected_changed_value["variants"],
changed_value["variants"])
def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)
if self.instance and self.instance.id:
self.old_serialized_vals = ChangeLogSerializer(self.instance).data
def test_serializer_outputs_expected_schema(self):
country1 = CountryFactory(code="CA", name="Canada")
locale1 = LocaleFactory(code="da", name="Danish")
experiment = ExperimentFactory.create(locales=[locale1],
countries=[country1])
related_exp = ExperimentFactory.create()
experiment.related_to.add(related_exp)
serializer = ChangeLogSerializer(experiment)
risk_tech_description = experiment.risk_technical_description
expected_data = {
"type":
experiment.type,
"owner":
experiment.owner.id,
"name":
experiment.name,
"short_description":
experiment.short_description,
"related_work":
experiment.related_work,
"related_to": [related_exp.id],
"proposed_start_date":
str(experiment.proposed_start_date),
"proposed_duration":
experiment.proposed_duration,
"proposed_enrollment":
experiment.proposed_enrollment,
"design":
experiment.design,
"addon_experiment_id":
experiment.addon_experiment_id,
"addon_release_url":
experiment.addon_release_url,
"pref_name":
experiment.pref_name,
"pref_type":
experiment.pref_type,
"pref_branch":
experiment.pref_branch,
"public_name":
experiment.public_name,
"public_description":
experiment.public_description,
"population_percent":
"{0:.4f}".format(experiment.population_percent),
"firefox_min_version":
experiment.firefox_min_version,
"firefox_max_version":
experiment.firefox_max_version,
"firefox_channel":
experiment.firefox_channel,
"client_matching":
experiment.client_matching,
"locales": [{
"code": "da",
"name": "Danish"
}],
"countries": [{
"code": "CA",
"name": "Canada"
}],
"platform":
experiment.platform,
"objectives":
experiment.objectives,
"analysis":
experiment.analysis,
"analysis_owner":
experiment.analysis_owner.id,
"survey_required":
experiment.survey_required,
"survey_urls":
experiment.survey_urls,
"survey_instructions":
experiment.survey_instructions,
"engineering_owner":
experiment.engineering_owner,
"bugzilla_id":
experiment.bugzilla_id,
"normandy_slug":
experiment.normandy_slug,
"normandy_id":
experiment.normandy_id,
"data_science_issue_url":
experiment.data_science_issue_url,
"feature_bugzilla_url":
experiment.feature_bugzilla_url,
"risk_partner_related":
experiment.risk_partner_related,
"risk_brand":
experiment.risk_brand,
"risk_fast_shipped":
experiment.risk_fast_shipped,
"risk_confidential":
experiment.risk_confidential,
"risk_release_population":
experiment.risk_release_population,
"risk_revenue":
experiment.risk_revenue,
"risk_data_category":
experiment.risk_data_category,
"risk_external_team_impact":
experiment.risk_external_team_impact,
"risk_telemetry_data":
experiment.risk_telemetry_data,
"risk_ux":
experiment.risk_ux,
"risk_security":
experiment.risk_security,
"risk_revision":
experiment.risk_revision,
"risk_technical":
experiment.risk_technical,
"risk_technical_description":
risk_tech_description,
"risks":
experiment.risks,
"testing":
experiment.testing,
"test_builds":
experiment.test_builds,
"qa_status":
experiment.qa_status,
"review_science":
experiment.review_science,
"review_engineering":
experiment.review_engineering,
"review_qa_requested":
experiment.review_qa_requested,
"review_intent_to_ship":
experiment.review_intent_to_ship,
"review_bugzilla":
experiment.review_bugzilla,
"review_qa":
experiment.review_qa,
"review_relman":
experiment.review_relman,
"review_advisory":
experiment.review_advisory,
"review_legal":
experiment.review_legal,
"review_ux":
experiment.review_ux,
"review_security":
experiment.review_security,
"review_vp":
experiment.review_vp,
"review_data_steward":
experiment.review_data_steward,
"review_comms":
experiment.review_comms,
"review_impacted_teams":
experiment.review_impacted_teams,
"variants": [
ExperimentVariantSerializer(variant).data
for variant in experiment.variants.all()
],
"results_url":
experiment.results_url,
"results_initial":
experiment.results_initial,
"results_lessons_learned":
experiment.results_lessons_learned,
"rollout_playbook":
experiment.rollout_playbook,
"rollout_type":
experiment.rollout_type,
}
self.assertEqual(set(serializer.data.keys()),
set(expected_data.keys()))
self.assertEqual(serializer.data, expected_data)