Remove the "Any" State from Notifications

[beeankha]

ISSUE TYPE

Remove the any state from unifiedjobtemplate_notification_templates and organization_notification_templates.

SUMMARY

The any state does not apply to all states, it only applies to one of two finished states (success/error). This can be confusing.

Removing the any state will enable the user to define what they mean by any, e.g., it's truly ALL of the states or it's only on job finish (the success/error/started states are additive, so they can select as many as they want).

Note on backwards compatibility: After the related data migration has been applied, all of the _any relationships will automatically be turned into two relationships, one success and one error.

[beeankha]

This issue is currently being worked on in PR #3982.

[Spredzy]

verified

[ryanpetrello]

@Spredzy did we actually test upgrade/migrations for these relationships on upgrade? I found a subtle bug while reviewing the PR that would have caused us to lose data on organization-wide any notifications on upgrade:

#3982 (comment)

I'd really like to see testing that involves setting up "any" relationships on:

• Organizations
• Job Templates
• Inventory Syncs
• Project Updates
• System Job Templates

And verifying that post-upgrade they all were converted to one success and one error.

[ryanpetrello]

@Spredzy we're merging a fix for this:

#4098

[Spredzy]

-----
Tower Version: 3.5.0
-----
Organizations remove_any_org_3

Notif Any: ['NotificationTemplate (slack) - ActorPipe쒃']
Notif Success: []
Notif Error: []


Job Templates remove_any_jt_3

Notif Any: ['NotificationTemplate (slack) - ActorPipe쒃']
Notif Success: []
Notif Error: []


Projects remove_any_proj_3

Notif Any: ['NotificationTemplate (slack) - ActorPipe쒃']
Notif Success: []
Notif Error: []


Inventory Sources remove_any_invetory_source_3

Notif Any: ['NotificationTemplate (slack) - ActorPipe쒃']
Notif Success: []
Notif Error: []


System Job Templates Cleanup Job Details

Notif Any: ['NotificationTemplate (slack) - ActorPipe쒃']
Notif Success: []
Notif Error: []

-----
Tower version: 3.6.0
-----
Organizations remove_any_org_3

Notif Success: ['NotificationTemplate (slack) - ActorPipe쒃']
Notif Error: ['NotificationTemplate (slack) - ActorPipe쒃']


Job Templates remove_any_jt_3

Notif Success: ['NotificationTemplate (slack) - ActorPipe쒃']
Notif Error: ['NotificationTemplate (slack) - ActorPipe쒃']


Projects remove_any_proj_3

Notif Success: ['NotificationTemplate (slack) - ActorPipe쒃']
Notif Error: ['NotificationTemplate (slack) - ActorPipe쒃']


Inventory Sources remove_any_invetory_source_3

Notif Success: ['NotificationTemplate (slack) - ActorPipe쒃']
Notif Error: ['NotificationTemplate (slack) - ActorPipe쒃']


System Job Templates Cleanup Job Details

Notif Success: ['NotificationTemplate (slack) - ActorPipe쒃']
Notif Error: ['NotificationTemplate (slack) - ActorPipe쒃']

Load script:

tower_version = v2.ping.get().instances[0].version                                                                                                                                             
                                                                                                                                                                                               
notif = v2.notification_templates.create(notif='test_remove_any_3')
org = v2.organizations.create(name='remove_any_org_3')
jt = v2.job_templates.create(name='remove_any_jt_3')
proj = v2.projects.create(name='remove_any_proj_3')
inv = v2.inventory_sources.create(name='remove_any_invetory_source_3')                                                                                                                         
sjt = v2.system_job_templates.get(id=1).results[0]                                                                                                                                             
                                                                                                                                                                                               
notif.associate(org)
notif.associate(jt)                                                                            
notif.associate(proj)                                                                                                                                                                          
notif.associate(inv)
notif.associate(sjt)

print("")
print("")
print("")
print("-----")
print("Tower version: %s" % tower_version)
print("-----")
print("Organizations %s" % org.name)
print("")
print("Notif Any: %s" % str([notif.name for notif in org.related.get('notification_templates_any').get().results]))
print("Notif Success: %s" % str([notif.name for notif in org.related.get('notification_templates_success').get().results]))
print("Notif Error: %s" % str([notif.name for notif in org.related.get('notification_templates_error').get().results]))
print("")
print("")
print("Job Templates %s" % jt.name)
print("")
print("Notif Any: %s" % str([notif.name for notif in jt.related.get('notification_templates_any').get().results]))
print("Notif Success: %s" % str([notif.name for notif in jt.related.get('notification_templates_success').get().results]))
print("Notif Error: %s" % str([notif.name for notif in jt.related.get('notification_templates_error').get().results]))
print("")
print("")
print("Projects %s" % proj.name)
print("")
print("Notif Any: %s" % str([notif.name for notif in proj.related.get('notification_templates_any').get().results]))
print("Notif Success: %s" % str([notif.name for notif in proj.related.get('notification_templates_success').get().results]))
print("Notif Error: %s" % str([notif.name for notif in proj.related.get('notification_templates_error').get().results]))
print("")
print("")
print("Inventory Sources %s" % inv.name)
print("")
print("Notif Any: %s" % str([notif.name for notif in inv.related.get('notification_templates_any').get().results]))
print("Notif Success: %s" % str([notif.name for notif in inv.related.get('notification_templates_success').get().results]))
print("Notif Error: %s" % str([notif.name for notif in inv.related.get('notification_templates_error').get().results]))
print("")
print("")
print("System Job Templates %s" % sjt.name)
print("")
print("Notif Any: %s" % str([notif.name for notif in sjt.related.get('notification_templates_any').get().results])) 
print("Notif Success: %s" % str([notif.name for notif in sjt.related.get('notification_templates_success').get().results])) 
print("Notif Error: %s" % str([notif.name for notif in sjt.related.get('notification_templates_error').get().results]))

Verify script:

tower_version = v2.ping.get().instances[0].version

org = v2.organizations.get(name='remove_any_org_3').results[0]
jt = v2.job_templates.get(name='remove_any_jt_3').results[0]
proj = v2.projects.get(name='remove_any_proj_3').results[0]
inv = v2.inventory_sources.get(name='remove_any_invetory_source_3').results[0]
sjt = v2.system_job_templates.get(id=1).results[0]


print("")
print("")
print("")
print("-----")
print("Tower version: %s" % tower_version)
print("-----")
print("Organizations %s" % org.name)
print("")
print("Notif Success: %s" % str([notif.name for notif in org.related.get('notification_templates_success').get().results]))
print("Notif Error: %s" % str([notif.name for notif in org.related.get('notification_templates_error').get().results]))
print("")
print("")
print("Job Templates %s" % jt.name)
print("")
print("Notif Success: %s" % str([notif.name for notif in jt.related.get('notification_templates_success').get().results]))
print("Notif Error: %s" % str([notif.name for notif in jt.related.get('notification_templates_error').get().results]))
print("")
print("")
print("Projects %s" % proj.name)
print("")
print("Notif Success: %s" % str([notif.name for notif in proj.related.get('notification_templates_success').get().results]))
print("Notif Error: %s" % str([notif.name for notif in proj.related.get('notification_templates_error').get().results]))
print("")
print("")
print("Inventory Sources %s" % inv.name)
print("")
print("Notif Success: %s" % str([notif.name for notif in inv.related.get('notification_templates_success').get().results]))
print("Notif Error: %s" % str([notif.name for notif in inv.related.get('notification_templates_error').get().results]))
print("")
print("")
print("System Job Templates %s" % sjt.name)
print("")
print("Notif Success: %s" % str([notif.name for notif in sjt.related.get('notification_templates_success').get().results]))
print("Notif Error: %s" % str([notif.name for notif in sjt.related.get('notification_templates_error').get().results]))