[ADD] Support for creating ParameterOverrides; fixes #20 (#23)

lxatstariongroup · web-flow · commit fb0cb1c55e4e · 2025-02-21T14:08:30.000+01:00
* [ADD] Support for creating ParameterOverrides
* [FIX] wrong ownership for ParameterOverride
* Remove comment
diff --git a/CDPBatchEditor.Tests/CDPBatchEditor.Tests.csproj b/CDPBatchEditor.Tests/CDPBatchEditor.Tests.csproj
@@ -12,19 +12,19 @@
     </PropertyGroup>
 
     <ItemGroup>
-        <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.9.0" />
-        <PackageReference Include="Moq" Version="4.20.70" />
-        <PackageReference Include="NUnit" Version="4.1.0" />
-        <PackageReference Include="NUnit.Console" Version="3.17.0" />
+        <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.13.0" />
+        <PackageReference Include="Moq" Version="4.20.72" />
+        <PackageReference Include="NUnit" Version="4.3.2" />
+        <PackageReference Include="NUnit.Console" Version="3.19.2" />
         <PackageReference Include="NUnit3TestAdapter" Version="4.5.0">
             <PrivateAssets>all</PrivateAssets>
             <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
         </PackageReference>
-        <PackageReference Include="coverlet.collector" Version="6.0.2">
+        <PackageReference Include="coverlet.collector" Version="6.0.4">
             <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
             <PrivateAssets>all</PrivateAssets>
         </PackageReference>
-        <PackageReference Include="coverlet.msbuild" Version="6.0.2">
+        <PackageReference Include="coverlet.msbuild" Version="6.0.4">
             <PrivateAssets>all</PrivateAssets>
             <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
         </PackageReference>
diff --git a/CDPBatchEditor.Tests/Commands/Command/OverrideCommandTestFixture.cs b/CDPBatchEditor.Tests/Commands/Command/OverrideCommandTestFixture.cs
@@ -0,0 +1,76 @@
+﻿//  --------------------------------------------------------------------------------------------------------------------
+//  <copyright file="OverrideCommandTestFixture.cs" company="Starion Group S.A.">
+//     Copyright (c) 2015-2024 Starion Group S.A.
+// 
+//     Author: Nathanael Smiechowski, Alex Vorobiev, Alexander van Delft, Sam Gerené
+// 
+//     This file is part of CDP4-COMET Batch Editor.
+//     The CDP4-COMET Batch Editor is a commandline application to perform batch operations on a
+//     ECSS-E-TM-10-25 Annex A and Annex C data source
+// 
+//     The CDP4-COMET Batch Editor is free software; you can redistribute it and/or
+//     modify it under the terms of the GNU Lesser General Public
+//     License as published by the Free Software Foundation; either
+//     version 3 of the License, or any later version.
+// 
+//     The CDP4-COMET Batch Editor is distributed in the hope that it will be useful,
+//     but WITHOUT ANY WARRANTY; without even the implied warranty of
+//     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+//     GNU Lesser General License version 3 for more details.
+// 
+//     You should have received a copy of the GNU Lesser General License
+//     along with this program.  If not, see <http://www.gnu.org/licenses/>.
+//  </copyright>
+//  --------------------------------------------------------------------------------------------------------------------
+
+namespace CDPBatchEditor.Tests.Commands.Command
+{
+    using System.Linq;
+
+    using CDP4Common.EngineeringModelData;
+
+    using CDPBatchEditor.CommandArguments;
+    using CDPBatchEditor.Commands.Command;
+
+    using NUnit.Framework;
+
+    [TestFixture]
+    public class OverrideCommandTestFixture : BaseCommandTestFixture
+    {
+        private OverrideCommand overrideCommand;
+
+        internal override void BuildAction(string action)
+        {
+            base.BuildAction(action);
+            this.overrideCommand = new OverrideCommand(this.CommandArguments, this.SessionService.Object, this.FilterService.Object);
+        }
+
+        [Test]
+        public void VerifyOverrideParameters()
+        {
+            const string parameterUserFriendlyShortName = "testParameter2", elementDefinitionShortName = "testElementDefinition";
+            this.BuildAction($"--action={CommandEnumeration.Override} -m TEST --parameters={parameterUserFriendlyShortName} --element-definition={elementDefinitionShortName} --included-owners={this.Domain.ShortName}");
+
+            Assert.That(this.Parameter2.ParameterSubscription.Any(), Is.False);
+
+            this.overrideCommand.Override();
+
+            Assert.That(this.Transactions.First().UpdatedThing.Count, Is.EqualTo(1));
+            Assert.That(this.Transactions.First().AddedThing.Count(), Is.EqualTo(1));
+
+            Assert.That(this.Transactions.Any(t => t.AddedThing
+                    .Any(p =>
+                        p is ParameterOverride s 
+                        && s.Owner == this.Domain
+                        && s.ParameterType.ShortName == parameterUserFriendlyShortName)),
+                Is.True);
+
+            Assert.That(this.Transactions.Any(t => t.UpdatedThing
+                    .Any(u => 
+                        u.Value is ElementUsage p 
+                        && p.ParameterOverride.Any(s => s.Owner.ShortName == this.Domain.ShortName)
+                    )),
+                Is.True);
+        }
+    }
+}
diff --git a/CDPBatchEditor.Tests/Commands/CommandDispatcherTestFixture.cs b/CDPBatchEditor.Tests/Commands/CommandDispatcherTestFixture.cs
@@ -47,6 +47,7 @@ public void Setup()
             this.commandArguments = new Mock<ICommandArguments>();
             this.parameterCommand = new Mock<IParameterCommand>();
             this.subscriptionCommand = new Mock<ISubscriptionCommand>();
+            this.overrideCommand = new Mock<IOverrideCommand>();
             this.optionCommand = new Mock<IOptionCommand>();
             this.scaleCommand = new Mock<IScaleCommand>();
             this.stateCommand = new Mock<IStateCommand>();
@@ -57,7 +58,7 @@ public void Setup()
             this.commandArguments.Setup(x => x.Report).Returns(true);
 
             this.commandDispatcher = new CommandDispatcher(
-                this.commandArguments.Object, this.parameterCommand.Object, this.subscriptionCommand.Object, this.optionCommand.Object,
+                this.commandArguments.Object, this.parameterCommand.Object, this.subscriptionCommand.Object, this.overrideCommand.Object, this.optionCommand.Object,
                 this.scaleCommand.Object, this.stateCommand.Object, this.domainCommand.Object, this.valueSetCommand.Object, this.reportGenerator.Object);
         }
 
@@ -70,6 +71,7 @@ public void Setup()
         private Mock<IDomainCommand> domainCommand;
         private Mock<IValueSetCommand> valueSetCommand;
         private Mock<IReportGenerator> reportGenerator;
+        private Mock<IOverrideCommand> overrideCommand;
         private CommandDispatcher commandDispatcher;
 
         [Test]
@@ -100,6 +102,7 @@ public void VerifyInvoke()
             this.optionCommand.Verify(x => x.ApplyOrRemoveOptionDependency(It.IsAny<bool>()), Times.Exactly(2));
             this.subscriptionCommand.Verify(x => x.Subscribe(), Times.Once);
             this.subscriptionCommand.Verify(x => x.SetParameterSubscriptionsSwitch(), Times.Once);
+            this.overrideCommand.Verify(x => x.Override(), Times.Once);
             this.parameterCommand.Verify(x => x.Add(), Times.Once);
             this.parameterCommand.Verify(x => x.Remove(), Times.Once);
             this.scaleCommand.Verify(x => x.AssignMeasurementScale(), Times.Once);
diff --git a/CDPBatchEditor/AppContainer.cs b/CDPBatchEditor/AppContainer.cs
@@ -66,6 +66,7 @@ public static void BuildContainer(ICommandArguments commandArguments)
             containerBuilder.RegisterType<ParameterCommand>().As<IParameterCommand>();
             containerBuilder.RegisterType<StateCommand>().As<IStateCommand>();
             containerBuilder.RegisterType<SubscriptionCommand>().As<ISubscriptionCommand>();
+            containerBuilder.RegisterType<OverrideCommand>().As<IOverrideCommand>();
             containerBuilder.RegisterType<ValueSetCommand>().As<IValueSetCommand>();
             containerBuilder.RegisterType<ScaleCommand>().As<IScaleCommand>();
             containerBuilder.RegisterType<OptionCommand>().As<IOptionCommand>();
diff --git a/CDPBatchEditor/CDPBatchEditor.csproj b/CDPBatchEditor/CDPBatchEditor.csproj
@@ -46,15 +46,15 @@
         </EmbeddedResource>
     </ItemGroup>
     <ItemGroup>
-        <PackageReference Include="CDP4Common-CE" Version="26.6.2" />
-        <PackageReference Include="CDP4Dal-CE" Version="26.6.2" />
-        <PackageReference Include="CDP4JsonFileDal-CE" Version="26.6.2" />
-        <PackageReference Include="CDP4JsonSerializer-CE" Version="26.6.2" />
-        <PackageReference Include="CDP4RequirementsVerification-CE" Version="26.6.2" />
-        <PackageReference Include="CDP4Rules-CE" Version="26.6.2" />
-        <PackageReference Include="CDP4ServicesDal-CE" Version="26.6.2" />
-        <PackageReference Include="CDP4WspDal-CE" Version="26.6.2" />
+        <PackageReference Include="CDP4Common-CE" Version="28.1.0" />
+        <PackageReference Include="CDP4Dal-CE" Version="28.1.0" />
+        <PackageReference Include="CDP4JsonFileDal-CE" Version="28.1.0" />
+        <PackageReference Include="CDP4JsonSerializer-CE" Version="28.1.0" />
+        <PackageReference Include="CDP4RequirementsVerification-CE" Version="28.1.0" />
+        <PackageReference Include="CDP4Rules-CE" Version="28.1.0" />
+        <PackageReference Include="CDP4ServicesDal-CE" Version="28.1.0" />
+        <PackageReference Include="CDP4WspDal-CE" Version="27.4.2" />
         <PackageReference Include="CommandLineParser" Version="2.9.1" />
-        <PackageReference Include="Autofac" Version="7.0.1" />
+        <PackageReference Include="Autofac" Version="8.2.0" />
     </ItemGroup>
 </Project>
diff --git a/CDPBatchEditor/CommandArguments/Arguments.cs b/CDPBatchEditor/CommandArguments/Arguments.cs
@@ -68,6 +68,7 @@ public class Arguments : ConnectionArguments, ICommandArguments
                        + "ApplyStateDependence,"
                        + "ChangeParameterOwnership,"
                        + "ChangeDomain,"
+                       + "Override,"
                        + "RemoveOptionDependence,"
                        + "RemoveStateDependence,"
                        + "SetGenericOwners,"
@@ -86,7 +87,7 @@ public class Arguments : ConnectionArguments, ICommandArguments
             Required = false,
             HelpText = "Comma-separated list of short names of parameters. "
                        + "Use in conjunction with --action=add-parameters | remove-parameters | change-parameter-ownership | subscribe "
-                       + "| apply-state-dependence | remove-state-dependence | apply-option-dependence | remove-option-dependence.")]
+                       + "| override | apply-state-dependence | remove-state-dependence | apply-option-dependence | remove-option-dependence.")]
         public IReadOnlyList<string> SelectedParameters { get; set; }
 
         /// <summary>
diff --git a/CDPBatchEditor/CommandArguments/CommandEnumeration.cs b/CDPBatchEditor/CommandArguments/CommandEnumeration.cs
@@ -70,6 +70,11 @@ public enum CommandEnumeration
         /// </summary>
         ChangeDomain,
 
+        /// <summary>
+        /// Override parameters #
+        /// </summary>
+        Override,
+
         /// <summary>
         /// Remove option dependency #
         /// </summary>
diff --git a/CDPBatchEditor/Commands/Command/Interface/IOverrideCommand.cs b/CDPBatchEditor/Commands/Command/Interface/IOverrideCommand.cs
@@ -0,0 +1,39 @@
+﻿//  --------------------------------------------------------------------------------------------------------------------
+//  <copyright file="IOverrideCommand.cs" company="Starion Group S.A.">
+//     Copyright (c) 2015-2024 Starion Group S.A.
+// 
+//     Author: Nathanael Smiechowski, Alex Vorobiev, Alexander van Delft, Sam Gerené
+// 
+//     This file is part of CDP4-COMET Batch Editor.
+//     The CDP4-COMET Batch Editor is a commandline application to perform batch operations on a
+//     ECSS-E-TM-10-25 Annex A and Annex C data source
+// 
+//     The CDP4-COMET Batch Editor is free software; you can redistribute it and/or
+//     modify it under the terms of the GNU Lesser General Public
+//     License as published by the Free Software Foundation; either
+//     version 3 of the License, or any later version.
+// 
+//     The CDP4-COMET Batch Editor is distributed in the hope that it will be useful,
+//     but WITHOUT ANY WARRANTY; without even the implied warranty of
+//     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+//     GNU Lesser General License version 3 for more details.
+// 
+//     You should have received a copy of the GNU Lesser General License
+//     along with this program.  If not, see <http://www.gnu.org/licenses/>.
+//  </copyright>
+//  --------------------------------------------------------------------------------------------------------------------
+
+namespace CDPBatchEditor.Commands.Command.Interface
+{
+    /// <summary>
+    /// Defines an <see cref="IOverrideCommand" /> that provides actions that are
+    /// <see cref="CDP4Common.EngineeringModelData.ParameterOverride" /> related
+    /// </summary>
+    public interface IOverrideCommand
+    {
+        /// <summary>
+        /// Override parameters with given short names.
+        /// </summary>
+        void Override();
+    }
+}
diff --git a/CDPBatchEditor/Commands/Command/Interface/ISubscriptionCommand.cs b/CDPBatchEditor/Commands/Command/Interface/ISubscriptionCommand.cs
@@ -25,6 +25,8 @@
 
 namespace CDPBatchEditor.Commands.Command.Interface
 {
+    using CDP4Common.EngineeringModelData;
+
     /// <summary>
     /// Defines an <see cref="IOptionCommand" /> that provides actions that are
     /// <see cref="CDP4Common.EngineeringModelData.Option" /> related
diff --git a/CDPBatchEditor/Commands/Command/OverrideCommand.cs b/CDPBatchEditor/Commands/Command/OverrideCommand.cs
@@ -0,0 +1,125 @@
+﻿//  --------------------------------------------------------------------------------------------------------------------
+//  <copyright file="OverrideCommand.cs" company="Starion Group S.A.">
+//     Copyright (c) 2015-2024 Starion Group S.A.
+// 
+//     Author: Nathanael Smiechowski, Alex Vorobiev, Alexander van Delft, Sam Gerené
+// 
+//     This file is part of CDP4-COMET Batch Editor.
+//     The CDP4-COMET Batch Editor is a commandline application to perform batch operations on a
+//     ECSS-E-TM-10-25 Annex A and Annex C data source
+// 
+//     The CDP4-COMET Batch Editor is free software; you can redistribute it and/or
+//     modify it under the terms of the GNU Lesser General Public
+//     License as published by the Free Software Foundation; either
+//     version 3 of the License, or any later version.
+// 
+//     The CDP4-COMET Batch Editor is distributed in the hope that it will be useful,
+//     but WITHOUT ANY WARRANTY; without even the implied warranty of
+//     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+//     GNU Lesser General License version 3 for more details.
+// 
+//     You should have received a copy of the GNU Lesser General License
+//     along with this program.  If not, see <http://www.gnu.org/licenses/>.
+//  </copyright>
+//  --------------------------------------------------------------------------------------------------------------------
+
+namespace CDPBatchEditor.Commands.Command
+{
+    using System;
+    using System.Linq;
+
+    using CDP4Common.EngineeringModelData;
+
+    using CDP4Dal.Operations;
+
+    using CDPBatchEditor.CommandArguments.Interface;
+    using CDPBatchEditor.Commands.Command.Interface;
+    using CDPBatchEditor.Services.Interfaces;
+
+    /// <summary>
+    /// Defines an <see cref="OverrideCommand" /> that provides actions that are
+    /// <see cref="CDP4Common.EngineeringModelData.ParameterOverride" /> related
+    /// </summary>
+    public class OverrideCommand : IOverrideCommand
+    {
+        /// <summary>
+        /// Gets the injected <see cref="ICommandArguments" /> instance
+        /// </summary>
+        private readonly ICommandArguments commandArguments;
+
+        /// <summary>
+        /// Gets the injected <see cref="IFilterService" /> instance
+        /// </summary>
+        private readonly IFilterService filterService;
+
+        /// <summary>
+        /// Gets the injected <see cref="ISessionService" /> instance
+        /// </summary>
+        private readonly ISessionService sessionService;
+
+        /// <summary>
+        /// Initialise a new <see cref="OverrideCommand" />
+        /// </summary>
+        /// <param name="commandArguments">the <see cref="ICommandArguments" /> arguments instance</param>
+        /// <param name="sessionService">
+        /// the <see cref="ISessionService" /> providing the <see cref="CDP4Dal.ISession" /> for the
+        /// application
+        /// </param>
+        /// <param name="filterService">the <see cref="IFilterService" /></param>
+        public OverrideCommand(ICommandArguments commandArguments, ISessionService sessionService, IFilterService filterService)
+        {
+            this.commandArguments = commandArguments;
+            this.sessionService = sessionService;
+            this.filterService = filterService;
+        }
+
+        /// <summary>
+        /// Override parameters with given short names, possibly filtered on Ownership (Included Owner) or Category.
+        /// </summary>
+        public void Override()
+        {
+            if (!this.commandArguments.SelectedParameters.Any())
+            {
+                Console.WriteLine("No --parameters given. Override parameters skipped.");
+                return;
+            }
+
+            var allElementUsages = this.sessionService.Iteration.Element.SelectMany(x => x.ContainedElement).ToArray();
+
+            foreach (var elementDefinition in this.sessionService.Iteration.Element
+                .Where(e => this.filterService.IsFilteredIn(e))
+                .OrderBy(x => x.ShortName).ToArray())
+            {
+                foreach (var elementDefinitionParameter in elementDefinition.Parameter)
+                {
+                    var overrider = elementDefinitionParameter.Owner;
+
+                    if (this.commandArguments.SelectedParameters.Contains(elementDefinitionParameter.ParameterType.ShortName))
+                    {
+                        var specificElementUsages = allElementUsages.Where(x => x.ElementDefinition == elementDefinition).ToArray();
+
+                        foreach (var elementUsage in specificElementUsages.OrderBy(x => x.ShortName))
+                        {
+                            if (elementUsage.ParameterOverride.All(x => x.Parameter != elementDefinitionParameter))
+                            {
+                                var elementUsageClone = elementUsage.Clone(true);
+
+                                this.sessionService.Transactions.Add(new ThingTransaction(TransactionContextResolver.ResolveContext(elementUsageClone), elementUsageClone));
+
+                                var parameterOverride = new ParameterOverride(Guid.NewGuid(), this.sessionService.Cache, this.commandArguments.ServerUri)
+                                {
+                                    Owner = overrider, 
+                                    Parameter = elementDefinitionParameter
+                                };
+
+                                this.sessionService.Transactions.Last().Create(parameterOverride, elementUsageClone);
+
+                                Console.WriteLine($"Parameter Override created on {parameterOverride.UserFriendlyShortName}");
+                            }
+                        }
+                    }
+                }
+            }
+        }
+    }
+}
diff --git a/CDPBatchEditor/Commands/CommandDispatcher.cs b/CDPBatchEditor/Commands/CommandDispatcher.cs
diff --git a/CDPBatchEditor/Services/SessionService.cs b/CDPBatchEditor/Services/SessionService.cs
diff --git a/CommandExamples.md b/CommandExamples.md

Original file line number	Diff line number	Diff line change
`@@ -25,6 +25,8 @@`
`25`	`25`
`26`	`26`	`namespace CDPBatchEditor.Commands.Command.Interface`
`27`	`27`	`{`
	`28`	`+ using CDP4Common.EngineeringModelData;`
	`29`	`+`
`28`	`30`	`/// <summary>`
`29`	`31`	`/// Defines an <see cref="IOptionCommand" /> that provides actions that are`
`30`	`32`	`/// <see cref="CDP4Common.EngineeringModelData.Option" /> related`