[Traits] Update to versioned schema

Closes #98.

As of TraitGen v1.0.0-alpha.13+ the YAML schema has been updated to
support versioned traits and specifications.

So update traits.yml to use the new schema.

This is a breaking change, in that older versions of the
`openassetio-traitgen` package will no longer work.

Signed-off-by: David Feltell <david.feltell@foundry.com>

Author: feltech

RELEASE_NOTES.md

@@ -1,6 +1,16 @@
 Release Notes
 =============
 
+v1.0.0-alpha.x
+---------------
+
+### Breaking changes
+
+- Update the traits YAML to be compatible with the new schema defined in
+  `openassetio-traitgen` v1.0.0-alpha.13+, which adds versioning to
+  traits and specifications.
+  [#98](https://github.com/OpenAssetIO/OpenAssetIO-MediaCreation/issues/98)
+
 v1.0.0-alpha.12
 ---------------
 

tests/cpp/test.cpp

@@ -9,7 +9,8 @@ using namespace openassetio_mediacreation;
 
 int main() {
   auto traits = openassetio::trait::TraitsData::make();
-  auto trait = traits::managementPolicy::ManagedTrait(traits);
+  auto deprecated = traits::managementPolicy::ManagedTrait(traits);
+  auto trait = traits::managementPolicy::ManagedTrait_v1(traits);
   trait.imbue();
   return 0;
 }

tests/python/openassetio_mediacreation/test_imports.py

@@ -39,6 +39,7 @@ def test_importing_namespace_succeeds(self):
 
     def test_importing_LocatableContentTrait_succeeds(self):
         from openassetio_mediacreation.traits.content import LocatableContentTrait
+        from openassetio_mediacreation.traits.content import LocatableContentTrait_v1
 
 
 class Test_trait_imports_managementPolicy:
@@ -47,6 +48,7 @@ def test_importing_namespace_succeeds(self):
 
     def test_importing_ManagedTrait_succeeds(self):
         from openassetio_mediacreation.traits.managementPolicy import ManagedTrait
+        from openassetio_mediacreation.traits.managementPolicy import ManagedTrait_v1
 
 
 class Test_trait_imports_identity:
@@ -55,6 +57,7 @@ def test_importing_namespace_succeeds(self):
 
     def test_importing_DisplayNameTrait_succeeds(self):
         from openassetio_mediacreation.traits.identity import DisplayNameTrait
+        from openassetio_mediacreation.traits.identity import DisplayNameTrait_v1
 
 
 class Test_trait_imports_auth:
@@ -63,6 +66,7 @@ def test_importing_namespace_succeeds(self):
 
     def test_importing_BearerToken_succeeds(self):
         from openassetio_mediacreation.traits.auth import BearerTokenTrait
+        from openassetio_mediacreation.traits.auth import BearerTokenTrait_v1
 
 
 class Test_trait_imports_application:
@@ -71,12 +75,15 @@ def test_importing_namespace_succeeds(self):
 
     def test_importing_Config_succeeds(self):
         from openassetio_mediacreation.traits.application import ConfigTrait
+        from openassetio_mediacreation.traits.application import ConfigTrait_v1
 
     def test_importing_Manifest_succeeds(self):
         from openassetio_mediacreation.traits.application import ManifestTrait
+        from openassetio_mediacreation.traits.application import ManifestTrait_v1
 
     def test_importing_Work_succeeds(self):
         from openassetio_mediacreation.traits.application import WorkTrait
+        from openassetio_mediacreation.traits.application import WorkTrait_v1
 
 
 class Test_trait_imports_usage:
@@ -85,9 +92,11 @@ def test_importing_namespace_succeeds(self):
 
     def test_importing_Entity_succeeds(self):
         from openassetio_mediacreation.traits.usage import EntityTrait
+        from openassetio_mediacreation.traits.usage import EntityTrait_v1
 
     def test_importing_Relationship_succeeds(self):
         from openassetio_mediacreation.traits.usage import RelationshipTrait
+        from openassetio_mediacreation.traits.usage import RelationshipTrait_v1
 
 
 class Test_trait_imports_lifecycle:
@@ -96,9 +105,11 @@ def test_importing_namespace_succeeds(self):
 
     def test_importing_Version_succeeds(self):
         from openassetio_mediacreation.traits.lifecycle import VersionTrait
+        from openassetio_mediacreation.traits.lifecycle import VersionTrait_v1
 
     def test_importing_Stable_succeeds(self):
         from openassetio_mediacreation.traits.lifecycle import StableTrait
+        from openassetio_mediacreation.traits.lifecycle import StableTrait_v1
 
 
 class Test_trait_imports_relationship:
@@ -107,9 +118,11 @@ def test_importing_namespace_succeeds(self):
 
     def test_importing_Singular_succeeds(self):
         from openassetio_mediacreation.traits.relationship import SingularTrait
+        from openassetio_mediacreation.traits.relationship import SingularTrait_v1
 
     def test_importing_Unbounded_succeeds(self):
         from openassetio_mediacreation.traits.relationship import UnboundedTrait
+        from openassetio_mediacreation.traits.relationship import UnboundedTrait_v1
 
 
 class Test_trait_imports_representation:
@@ -118,9 +131,11 @@ def test_importing_namespace_succeeds(self):
 
     def test_importing_Proxy_succeeds(self):
         from openassetio_mediacreation.traits.representation import ProxyTrait
+        from openassetio_mediacreation.traits.representation import ProxyTrait_v1
 
     def test_importing_Original_succeeds(self):
         from openassetio_mediacreation.traits.representation import OriginalTrait
+        from openassetio_mediacreation.traits.representation import OriginalTrait_v1
 
 
 class Test_trait_imports_timeDomain:
@@ -129,9 +144,11 @@ def test_importing_namespace_succeeds(self):
 
     def test_importing_FrameRanged_succeeds(self):
         from openassetio_mediacreation.traits.timeDomain import FrameRangedTrait
+        from openassetio_mediacreation.traits.timeDomain import FrameRangedTrait_v1
 
     def test_importing_Static_succeeds(self):
         from openassetio_mediacreation.traits.timeDomain import StaticTrait
+        from openassetio_mediacreation.traits.timeDomain import StaticTrait_v1
 
 
 class Test_trait_imports_twoDimensional:
@@ -140,12 +157,15 @@ def test_importing_namespace_succeeds(self):
 
     def test_importing_Image_succeeds(self):
         from openassetio_mediacreation.traits.twoDimensional import ImageTrait
+        from openassetio_mediacreation.traits.twoDimensional import ImageTrait_v1
 
     def test_importing_PixelBased_succeeds(self):
         from openassetio_mediacreation.traits.twoDimensional import PixelBasedTrait
+        from openassetio_mediacreation.traits.twoDimensional import PixelBasedTrait_v1
 
     def test_importing_Deep_succeeds(self):
         from openassetio_mediacreation.traits.twoDimensional import DeepTrait
+        from openassetio_mediacreation.traits.twoDimensional import DeepTrait_v1
 
 
 class Test_trait_imports_threeDimensional:
@@ -154,24 +174,31 @@ def test_importing_namespace_succeeds(self):
 
     def test_importing_Spatial_succeeds(self):
         from openassetio_mediacreation.traits.threeDimensional import SpatialTrait
+        from openassetio_mediacreation.traits.threeDimensional import SpatialTrait_v1
 
     def test_importing_GeometryTrait_succeeds(self):
         from openassetio_mediacreation.traits.threeDimensional import GeometryTrait
+        from openassetio_mediacreation.traits.threeDimensional import GeometryTrait_v1
 
     def test_importing_Lighting_succeeds(self):
         from openassetio_mediacreation.traits.threeDimensional import LightingTrait
+        from openassetio_mediacreation.traits.threeDimensional import LightingTrait_v1
 
     def test_importing_Shader_succeeds(self):
         from openassetio_mediacreation.traits.threeDimensional import ShaderTrait
+        from openassetio_mediacreation.traits.threeDimensional import ShaderTrait_v1
 
     def test_importing_IESProfile_succeeds(self):
         from openassetio_mediacreation.traits.threeDimensional import IESProfileTrait
+        from openassetio_mediacreation.traits.threeDimensional import IESProfileTrait_v1
 
     def test_importing_SourcePath_succeeds(self):
         from openassetio_mediacreation.traits.threeDimensional import SourcePathTrait
+        from openassetio_mediacreation.traits.threeDimensional import SourcePathTrait_v1
 
     def test_importing_SourcePaths_succeeds(self):
         from openassetio_mediacreation.traits.threeDimensional import SourcePathsTrait
+        from openassetio_mediacreation.traits.threeDimensional import SourcePathsTrait_v1
 
 
 class Test_trait_imports_metadata:
@@ -180,6 +207,7 @@ def test_importing_namespace_succeeds(self):
 
     def test_importing_Camera_succeeds(self):
         from openassetio_mediacreation.traits.metadata import ArbitraryMetadataTrait
+        from openassetio_mediacreation.traits.metadata import ArbitraryMetadataTrait_v1
 
 
 class Test_trait_imports_imaging:
@@ -188,6 +216,7 @@ def test_importing_namespace_succeeds(self):
 
     def test_importing_Camera_succeeds(self):
         from openassetio_mediacreation.traits.imaging import CameraTrait
+        from openassetio_mediacreation.traits.imaging import CameraTrait_v1
 
 
 class Test_trait_imports_color:
@@ -196,6 +225,7 @@ def test_importing_namespace_succeeds(self):
 
     def test_importing_Camera_succeeds(self):
         from openassetio_mediacreation.traits.color import OCIOColorManagedTrait
+        from openassetio_mediacreation.traits.color import OCIOColorManagedTrait_v1
 
 
 class Test_trait_imports_audio:
@@ -204,9 +234,11 @@ def test_importing_namespace_succeeds(self):
 
     def test_importing_Audio_succeeds(self):
         from openassetio_mediacreation.traits.audio import AudioTrait
+        from openassetio_mediacreation.traits.audio import AudioTrait_v1
 
     def test_importing_SampleBased_succeeds(self):
         from openassetio_mediacreation.traits.audio import SampleBasedTrait
+        from openassetio_mediacreation.traits.audio import SampleBasedTrait_v1
 
 
 class Test_specification_imports_lifecycle:
@@ -216,16 +248,19 @@ def test_importing_namespace_succeeds(self):
     def test_importing_EntityVersionsRelationship_succeeds(self):
         from openassetio_mediacreation.specifications.lifecycle import (
             EntityVersionsRelationshipSpecification,
+            EntityVersionsRelationshipSpecification_v1,
         )
 
     def test_importing_StableEntityVersionsRelationship_succeeds(self):
         from openassetio_mediacreation.specifications.lifecycle import (
             StableEntityVersionsRelationshipSpecification,
+            StableEntityVersionsRelationshipSpecification_v1,
         )
 
     def test_importing_StableReferenceRelationship_succeeds(self):
         from openassetio_mediacreation.specifications.lifecycle import (
             StableReferenceRelationshipSpecification,
+            StableReferenceRelationshipSpecification_v1,
         )
 
 
@@ -236,11 +271,13 @@ def test_importing_namespace_succeeds(self):
     def test_importing_OriginalRepresentationRelationship_succeeds(self):
         from openassetio_mediacreation.specifications.representation import (
             OriginalRepresentationRelationshipSpecification,
+            OriginalRepresentationRelationshipSpecification_v1,
         )
 
     def test_importing_ProxyRepresentationRelationship_succeeds(self):
         from openassetio_mediacreation.specifications.representation import (
             ProxyRepresentationRelationshipSpecification,
+            ProxyRepresentationRelationshipSpecification_v1,
         )
 
 
@@ -249,16 +286,21 @@ def test_importing_namespace_succeeds(self):
         from openassetio_mediacreation.specifications import twoDimensional
 
     def test_importing_Image_succeeds(self):
-        from openassetio_mediacreation.specifications.twoDimensional import ImageSpecification
+        from openassetio_mediacreation.specifications.twoDimensional import (
+            ImageSpecification,
+            ImageSpecification_v1,
+        )
 
     def test_importing_BitmapImageResource_succeeds(self):
         from openassetio_mediacreation.specifications.twoDimensional import (
             BitmapImageResourceSpecification,
+            BitmapImageResourceSpecification_v1,
         )
 
     def test_importing_DeepBitmapImageResource_succeeds(self):
         from openassetio_mediacreation.specifications.twoDimensional import (
             DeepBitmapImageResourceSpecification,
+            DeepBitmapImageResourceSpecification_v1,
         )
 
 
@@ -267,36 +309,45 @@ def test_importing_namespace_succeeds(self):
         from openassetio_mediacreation.specifications import threeDimensional
 
     def test_importing_Spatial_succeeds(self):
-        from openassetio_mediacreation.specifications.threeDimensional import SpatialSpecification
+        from openassetio_mediacreation.specifications.threeDimensional import (
+            SpatialSpecification,
+            SpatialSpecification_v1,
+        )
 
     def test_importing_SceneResource_succeeds(self):
         from openassetio_mediacreation.specifications.threeDimensional import (
             SceneResourceSpecification,
+            SceneResourceSpecification_v1,
         )
 
     def test_importing_SceneGeometryResource_succeeds(self):
         from openassetio_mediacreation.specifications.threeDimensional import (
             SceneGeometryResourceSpecification,
+            SceneGeometryResourceSpecification_v1,
         )
 
     def test_importing_SceneCameraResource_succeeds(self):
         from openassetio_mediacreation.specifications.threeDimensional import (
             SceneCameraResourceSpecification,
+            SceneCameraResourceSpecification_v1,
         )
 
     def test_importing_SceneLightingResource_succeeds(self):
         from openassetio_mediacreation.specifications.threeDimensional import (
             SceneLightingResourceSpecification,
+            SceneLightingResourceSpecification_v1,
         )
 
     def test_importing_ShaderResource_succeeds(self):
         from openassetio_mediacreation.specifications.threeDimensional import (
             ShaderResourceSpecification,
+            ShaderResourceSpecification_v1,
         )
 
     def test_importing_IESProfileResource_succeeds(self):
         from openassetio_mediacreation.specifications.threeDimensional import (
             IESProfileResourceSpecification,
+            IESProfileResourceSpecification_v1,
         )
 
 
@@ -305,11 +356,15 @@ def test_importing_namespace_succeeds(self):
         from openassetio_mediacreation.specifications import audio
 
     def test_importing_Audio_succeeds(self):
-        from openassetio_mediacreation.specifications.audio import AudioSpecification
+        from openassetio_mediacreation.specifications.audio import (
+            AudioSpecification,
+            AudioSpecification_v1,
+        )
 
     def test_importing_SampledAudioResource_succeeds(self):
         from openassetio_mediacreation.specifications.audio import (
             SampledAudioResourceSpecification,
+            SampledAudioResourceSpecification_v1,
         )
 
 
@@ -318,4 +373,7 @@ def test_importing_namespace_succeeds(self):
         from openassetio_mediacreation.specifications import application
 
     def test_importing_workfile_succeeds(self):
-        from openassetio_mediacreation.specifications.application import WorkfileSpecification
+        from openassetio_mediacreation.specifications.application import (
+            WorkfileSpecification,
+            WorkfileSpecification_v1,
+        )

tests/python/openassetio_mediacreation/test_specifications.py

@@ -46,7 +46,7 @@ def test_relationship_names_suffixed(self):
         """
         for cls in self.__specifications():
             if RelationshipTrait.kId in cls.kTraitSet:
-                assert cls.__name__.endswith("RelationshipSpecification")
+                assert cls.__name__.endswith("RelationshipSpecification_v1")
 
     def __specifications(self):
         """
@@ -57,7 +57,7 @@ def __specifications(self):
         for _, namespace in namespaces:
             classes = inspect.getmembers(namespace, inspect.isclass)
             for _, cls in classes:
-                if cls.__name__.endswith("Specification"):
+                if cls.__name__.endswith("Specification_v1"):
                     specs.append(cls)
         assert specs
         return specs