3.0.0 Schema changes

[gilesknap]

This change allows us to more effectively use anchors and aliases to (multiple) inherit groups of parameters from other definitions or from shared fields.

Also includes a converter tool to convert support yaml and ioc yaml to work with the latest round of changes to ibek.

The names of the classes in the code have also been changed to reflect the name changes in the schema detailed below.

The schema changes are as follows:

• defs are now entity_models
• args are now parameters
• parameters are a dictionary of dictionaries instead of a list of dictionaries
• parameters no longer have a name field as the key in the dictionary is the name
• values is now post_defines and is also a dictionary of dictionaries
• pre_values is now pre_defines and is also a dictionary of dictionaries
• __utils__ is now _global
• _global functions have changed:
  • get_var -> get
  • set_var -> set
  • counter -> incrementor
    • behaviour has changed: the --increment and --stop flags are interpreted on every invocation of the incrementor function (so non linear counters are possible)
    • incrementors current value is accessible via _global.get(incrementorName)

Backward compatible changes:

• object refs are literally the object - so you can modify a referenced object's attributes (with appropriate care!!)
• pre_defines and post_defines now may have optional type: which defaults to str and may be
  • list (of Any), int, float, bool
• each entity_model may have a shared: field which is a list of Any
• there is also a global shared: at the root level
• shared: are scratch areas in which to place anchors that can be referred to by aliases - and are therefore useful for placing repeating patterns (especially of parameters) and then using aliases where these repeats are required.

[gilesknap]

NOTE: this is breaking the system test because it uses ioc-template-example and that in turn is using ibek-support which has not been updated to the new schema changes yet.

NEXT CALL: adding CI to ibek support that checks all of this so I can

• validate that CI runs against current ibek-support with ibek 2.x
• do the conversion on all ibek-support
• validate that the CI runs with the new ibek 3.x (the CI will include a requirements.txt for a compatible ibek version)
• fix the ioc-template to use the above version of ibek-support AND the 3.x version of ibek (not required for this system test but required so that ioc-template-example's own CI works)
• re-generate ioc-template-example
• re run the CI for ibek

Some notes on the remaining points to complete in this PR

[gilesknap]

@GDYendell after around 12 hours in a debugger it finally came out pretty in my opinion.

All jina rendering and reference to pre_defines and post_defines are all handled in the Entity model validator here: https://github.com/epics-containers/ibek/blob/2bd5cb3a9a32fa17195a0553597b4b88abc00882/src/ibek/ioc.py#L97-L122

(I think we eventually agreed that define may be used as a noun, right?)

[GDYendell]

I think this PR needs to be renamed "Refactor the world"

[gilesknap]

I think this PR needs to be renamed "Refactor the world"

Was just thinking what to call it.

But here is the cool bit.

• I wrote CI for ibek-support that checks a bunch of generic ioc builds and ioc instance renders for all ioc instances in bl47p bl45p and bl01t
• then I ran the auto converter on all of the support yaml and ioc yaml
• plus updated the CI ibek version to latest
• the CI picked up a single change which is that an enum was now correctly rendering in a subst file

Now this has only checked support yaml for those things we have actual IOC instances for but it is a very good cross-section.

[gilesknap]

@GDYendell

I have clarified the ID discussion as follows: https://github.com/epics-containers/ibek/blob/db46dbaef4ba1f77eaa96ee12eba29908d9df6b3/src/ibek/ioc.py#L124-L139 and https://github.com/epics-containers/ibek/blob/0043ef5a11a21a929311682c20dddb062cfcb94c/src/ibek/entity_model.py#L178-L190