def test_generate_nimbus_changelog_with_prior_change(self):
experiment = NimbusExperimentFactory.create_with_lifecycle(
NimbusExperimentFactory.Lifecycles.CREATED)
self.assertEqual(experiment.changes.count(), 1)
experiment.status = NimbusExperiment.Status.DRAFT
experiment.status_next = NimbusExperiment.Status.LIVE
experiment.publish_status = NimbusExperiment.PublishStatus.REVIEW
experiment.save()
generate_nimbus_changelog(experiment, self.user, "test message")
self.assertEqual(experiment.changes.count(), 2)
change = experiment.changes.latest_change()
self.assertEqual(change.experiment, experiment)
self.assertEqual(change.message, "test message")
self.assertEqual(change.changed_by, self.user)
self.assertEqual(change.old_status, NimbusExperiment.Status.DRAFT)
self.assertEqual(change.old_status_next, None)
self.assertEqual(change.old_publish_status,
NimbusExperiment.PublishStatus.IDLE)
self.assertEqual(change.new_status, NimbusExperiment.Status.DRAFT)
self.assertEqual(change.new_status_next, NimbusExperiment.Status.LIVE)
self.assertEqual(change.new_publish_status,
NimbusExperiment.PublishStatus.REVIEW)
self.assertEqual(
change.experiment_data,
dict(NimbusExperimentChangeLogSerializer(experiment).data),
)
def test_generate_nimbus_changelog_without_prior_change(self):
experiment = NimbusExperimentFactory.create()
self.assertEqual(experiment.changes.count(), 0)
generate_nimbus_changelog(experiment, self.user, "test message")
self.assertEqual(experiment.changes.count(), 1)
change = experiment.changes.get()
self.assertEqual(change.experiment, experiment)
self.assertEqual(change.message, "test message")
self.assertEqual(change.changed_by, self.user)
self.assertEqual(change.old_status, None)
self.assertEqual(change.old_status_next, None)
self.assertEqual(change.old_publish_status, None)
self.assertEqual(change.new_status, NimbusExperiment.Status.DRAFT)
self.assertEqual(change.new_status_next, None)
self.assertEqual(change.new_publish_status,
NimbusExperiment.PublishStatus.IDLE)
self.assertEqual(
change.experiment_data,
dict(NimbusExperimentChangeLogSerializer(experiment).data),
)
def test_outputs_expected_schema_for_empty_experiment(self):
experiment = NimbusExperiment()
data = dict(NimbusExperimentChangeLogSerializer(experiment).data)
self.assertEqual(
data,
{
"application": None,
"branches": [],
"channel": None,
"reference_branch": None,
"feature_config": None,
"firefox_min_version": None,
"hypothesis": NimbusExperiment.HYPOTHESIS_DEFAULT,
"is_paused": False,
"name": "",
"owner": None,
"population_percent": "0.0000",
"probe_sets": [],
"projects": [],
"proposed_duration": None,
"proposed_enrollment": None,
"public_description": None,
"slug": "",
"status": NimbusExperiment.Status.DRAFT.value,
"targeting_config_slug": None,
"total_enrolled_clients": 0,
},
)
class NimbusChangeLogFactory(factory.django.DjangoModelFactory):
experiment = factory.SubFactory(NimbusExperimentFactory)
changed_by = factory.SubFactory(UserFactory)
old_status = NimbusExperiment.Status.DRAFT
new_status = NimbusExperiment.Status.DRAFT
message = factory.LazyAttribute(lambda o: faker.catch_phrase())
experiment_data = factory.LazyAttribute(
lambda o: dict(NimbusExperimentChangeLogSerializer(o.experiment).data))
class Meta:
model = NimbusChangeLog
def test_outputs_expected_schema_for_empty_experiment(self):
owner = UserFactory.create()
experiment = NimbusExperiment.objects.create(owner=owner)
data = dict(NimbusExperimentChangeLogSerializer(experiment).data)
self.assertEqual(
data,
{
"application": "",
"branches": [],
"channel": NimbusExperiment.Channel.NO_CHANNEL,
"countries": [],
"feature_config": None,
"firefox_min_version": NimbusExperiment.Version.NO_VERSION,
"hypothesis": NimbusExperiment.HYPOTHESIS_DEFAULT,
"is_paused": False,
"locales": [],
"name": "",
"owner": owner.email,
"population_percent": "0.0000",
"primary_outcomes": [],
"projects": [],
"proposed_duration":
NimbusExperiment.DEFAULT_PROPOSED_DURATION,
"proposed_enrollment":
NimbusExperiment.DEFAULT_PROPOSED_ENROLLMENT,
"public_description": "",
"publish_status": NimbusExperiment.PublishStatus.IDLE.value,
"published_dto": None,
"results_data": None,
"reference_branch": None,
"risk_brand": None,
"risk_mitigation_link": "",
"risk_partner_related": None,
"risk_revenue": None,
"secondary_outcomes": [],
"slug": "",
"status": NimbusExperiment.Status.DRAFT.value,
"status_next": None,
"targeting_config_slug":
NimbusExperiment.TargetingConfig.NO_TARGETING,
"total_enrolled_clients": 0,
},
)
def test_generate_nimbus_changelog_with_prior_change(self):
experiment = NimbusExperimentFactory.create_with_status(
NimbusExperiment.Status.DRAFT)
self.assertEqual(experiment.changes.count(), 1)
generate_nimbus_changelog(experiment, self.user)
self.assertEqual(experiment.changes.count(), 2)
change = experiment.latest_change()
self.assertEqual(change.experiment, experiment)
self.assertEqual(change.changed_by, self.user)
self.assertEqual(change.old_status, NimbusExperiment.Status.DRAFT)
self.assertEqual(change.new_status, NimbusExperiment.Status.DRAFT)
self.assertEqual(
change.experiment_data,
dict(NimbusExperimentChangeLogSerializer(experiment).data),
)
def test_outputs_expected_schema_for_complete_experiment(self):
application = NimbusExperiment.Application.DESKTOP
feature_config = NimbusFeatureConfigFactory.create()
project = ProjectFactory.create()
primary_outcome = Outcomes.by_application(application)[0].slug
secondary_outcome = Outcomes.by_application(application)[1].slug
experiment = NimbusExperimentFactory.create_with_lifecycle(
NimbusExperimentFactory.Lifecycles.ENDING_APPROVE_APPROVE,
application=application,
feature_config=feature_config,
projects=[project],
primary_outcomes=[primary_outcome],
secondary_outcomes=[secondary_outcome],
)
data = dict(NimbusExperimentChangeLogSerializer(experiment).data)
branches_data = [dict(b) for b in data.pop("branches")]
control_branch_data = dict(data.pop("reference_branch"))
locales_data = data.pop("locales")
countries_data = data.pop("countries")
feature_config_data = data.pop("feature_config")
published_dto_data = data.pop("published_dto")
self.assertEqual(
data,
{
"application": experiment.application,
"channel": experiment.channel,
"firefox_min_version": experiment.firefox_min_version,
"hypothesis": experiment.hypothesis,
"is_paused": experiment.is_paused,
"name": experiment.name,
"owner": experiment.owner.email,
"population_percent": str(experiment.population_percent),
"primary_outcomes": [primary_outcome],
"projects": [project.slug],
"proposed_duration": experiment.proposed_duration,
"proposed_enrollment": experiment.proposed_enrollment,
"public_description": experiment.public_description,
"publish_status": experiment.publish_status,
"results_data": None,
"risk_brand": experiment.risk_brand,
"risk_mitigation_link": experiment.risk_mitigation_link,
"risk_partner_related": experiment.risk_partner_related,
"risk_revenue": experiment.risk_revenue,
"secondary_outcomes": [secondary_outcome],
"slug": experiment.slug,
"status": experiment.status,
"status_next": experiment.status_next,
"targeting_config_slug": experiment.targeting_config_slug,
"total_enrolled_clients": experiment.total_enrolled_clients,
},
)
self.assertEqual(
published_dto_data.keys(),
dict(NimbusExperimentSerializer(experiment).data).keys(),
)
self.assertEqual(
feature_config_data,
{
"name": feature_config.name,
"slug": feature_config.slug,
"description": feature_config.description,
"application": feature_config.application,
"owner_email": feature_config.owner_email,
"schema": feature_config.schema,
},
)
self.assertEqual(
set(locales_data),
set(experiment.locales.all().values_list("code", flat=True)),
)
self.assertEqual(
set(countries_data),
set(experiment.countries.all().values_list("code", flat=True)),
)
self.assertEqual(
control_branch_data,
{
"description": experiment.reference_branch.description,
"feature_enabled": experiment.reference_branch.feature_enabled,
"feature_value": experiment.reference_branch.feature_value,
"name": experiment.reference_branch.name,
"ratio": experiment.reference_branch.ratio,
"slug": experiment.reference_branch.slug,
},
)
for branch in experiment.branches.all():
self.assertIn(
{
"description": branch.description,
"feature_enabled": branch.feature_enabled,
"feature_value": branch.feature_value,
"name": branch.name,
"ratio": branch.ratio,
"slug": branch.slug,
},
branches_data,
)
def test_outputs_expected_schema_for_complete_experiment(self):
application = NimbusExperiment.Application.DESKTOP
probe_set = NimbusProbeSetFactory.create()
feature_config = NimbusFeatureConfigFactory.create()
project = ProjectFactory.create()
experiment = NimbusExperimentFactory.create_with_status(
NimbusExperiment.Status.COMPLETE,
application=application,
probe_sets=[probe_set],
feature_config=feature_config,
projects=[project],
)
data = dict(NimbusExperimentChangeLogSerializer(experiment).data)
branches_data = [dict(b) for b in data.pop("branches")]
control_branch_data = dict(data.pop("reference_branch"))
self.assertEqual(
data,
{
"application": experiment.application,
"channel": experiment.channel,
"feature_config": {
"name": feature_config.name,
"slug": feature_config.slug,
"description": feature_config.description,
"application": feature_config.application,
"owner_email": feature_config.owner_email,
"schema": None,
},
"firefox_min_version": experiment.firefox_min_version,
"hypothesis": experiment.hypothesis,
"is_paused": experiment.is_paused,
"name": experiment.name,
"owner": experiment.owner.email,
"population_percent": str(experiment.population_percent),
"probe_sets": [probe_set.slug],
"projects": [project.slug],
"proposed_duration": experiment.proposed_duration,
"proposed_enrollment": experiment.proposed_enrollment,
"public_description": experiment.public_description,
"slug": experiment.slug,
"status": experiment.status,
"targeting_config_slug": experiment.targeting_config_slug,
"total_enrolled_clients": experiment.total_enrolled_clients,
},
)
self.assertEqual(
control_branch_data,
{
"description": experiment.reference_branch.description,
"feature_enabled": experiment.reference_branch.feature_enabled,
"feature_value": experiment.reference_branch.feature_value,
"name": experiment.reference_branch.name,
"ratio": experiment.reference_branch.ratio,
"slug": experiment.reference_branch.slug,
},
)
for branch in experiment.branches.all():
self.assertIn(
{
"description": branch.description,
"feature_enabled": branch.feature_enabled,
"feature_value": branch.feature_value,
"name": branch.name,
"ratio": branch.ratio,
"slug": branch.slug,
},
branches_data,
)