Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Browse files
Browse the repository at this point in the history
* Add more logging statements and FluentResults to use it instead of return just a task * Add extension methods to the session service * Fix tests * Add small test * Upgrade version
- Loading branch information
1 parent
bc41740
commit dfd672d
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,91 @@ | ||
| // -------------------------------------------------------------------------------------------------------------------- | ||
| // <copyright file="SessionServiceExtensionsTestFixture.cs" company="RHEA System S.A."> | ||
| // Copyright (c) 2023 RHEA System S.A. | ||
| // | ||
| // Authors: Sam Gerené, Alex Vorobiev, Alexander van Delft, Jaime Bernar, Théate Antoine | ||
| // | ||
| // This file is part of COMET WEB Community Edition | ||
| // The COMET WEB Community Edition is the RHEA Web Application implementation of ECSS-E-TM-10-25 Annex A and Annex C. | ||
| // | ||
| // The COMET WEB Community Edition is free software; you can redistribute it and/or | ||
| // modify it under the terms of the GNU Affero General Public | ||
| // License as published by the Free Software Foundation; either | ||
| // version 3 of the License, or (at your option) any later version. | ||
| // | ||
| // The COMET WEB Community Edition 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 | ||
| // Affero General Public License for more details. | ||
| // | ||
| // You should have received a copy of the GNU Affero General Public License | ||
| // along with this program. If not, see <http://www.gnu.org/licenses/>. | ||
| // </copyright> | ||
| // -------------------------------------------------------------------------------------------------------------------- | ||
|
|
||
| namespace COMET.Web.Common.Tests.Extensions | ||
| { | ||
| using CDP4Common.EngineeringModelData; | ||
| using CDP4Common.SiteDirectoryData; | ||
|
|
||
| using CDP4Dal; | ||
| using CDP4Dal.Operations; | ||
|
|
||
| using COMET.Web.Common.Extensions; | ||
| using COMET.Web.Common.Services.SessionManagement; | ||
| using Microsoft.Extensions.Logging; | ||
| using Moq; | ||
| using NUnit.Framework; | ||
|
|
||
| [TestFixture] | ||
| public class SessionServiceExtensionsTestFixture | ||
| { | ||
| private Mock<ISession> session; | ||
| private ISessionService sessionService; | ||
|
|
||
| [SetUp] | ||
| public void Setup() | ||
| { | ||
| var logger = new Mock<ILogger<SessionService>>(); | ||
|
|
||
| this.session = new Mock<ISession>(); | ||
| this.sessionService = new SessionService(logger.Object) | ||
| { | ||
| Session = this.session.Object | ||
| }; | ||
| } | ||
|
|
||
| [Test] | ||
| public void VerifyAddParameter() | ||
| { | ||
| var model = new EngineeringModel(); | ||
| var iterationSetup = new IterationSetup(); | ||
| var iteration = new Iteration() | ||
| { | ||
| IterationSetup = iterationSetup, | ||
| Container = model | ||
| }; | ||
| model.Iteration.Add(iteration); | ||
|
|
||
| var elementDefinition = new ElementDefinition(); | ||
| iteration.Element.Add(elementDefinition); | ||
|
|
||
| var textParameterType = new TextParameterType(); | ||
|
|
||
| var doe = new DomainOfExpertise() | ||
| { | ||
| Name = "doe", | ||
| ShortName = "doe" | ||
| }; | ||
|
|
||
| Assert.Multiple(() => | ||
| { | ||
| Assert.That(() => this.sessionService.AddParameter(null, null, null, null, null), Throws.ArgumentNullException); | ||
| Assert.That(() => this.sessionService.AddParameter(elementDefinition, null, null, null, null), Throws.ArgumentNullException); | ||
| Assert.That(() => this.sessionService.AddParameter(elementDefinition, null, textParameterType, null, null), Throws.ArgumentNullException); | ||
| Assert.That(() => this.sessionService.AddParameter(elementDefinition, null, textParameterType, null, doe), Throws.Nothing); | ||
| }); | ||
|
|
||
| this.session.Verify(x => x.Write(It.IsAny<OperationContainer>()), Times.Once); | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,87 @@ | ||
| // -------------------------------------------------------------------------------------------------------------------- | ||
| // <copyright file="SessionServiceExtensions.cs" company="RHEA System S.A."> | ||
| // Copyright (c) 2023 RHEA System S.A. | ||
| // | ||
| // Authors: Sam Gerené, Alex Vorobiev, Alexander van Delft, Jaime Bernar, Théate Antoine | ||
| // | ||
| // This file is part of COMET WEB Community Edition | ||
| // The COMET WEB Community Edition is the RHEA Web Application implementation of ECSS-E-TM-10-25 Annex A and Annex C. | ||
| // | ||
| // The COMET WEB Community Edition is free software; you can redistribute it and/or | ||
| // modify it under the terms of the GNU Affero General Public | ||
| // License as published by the Free Software Foundation; either | ||
| // version 3 of the License, or (at your option) any later version. | ||
| // | ||
| // The COMET WEB Community Edition 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 | ||
| // Affero General Public License for more details. | ||
| // | ||
| // You should have received a copy of the GNU Affero General Public License | ||
| // along with this program. If not, see <http://www.gnu.org/licenses/>. | ||
| // </copyright> | ||
| // -------------------------------------------------------------------------------------------------------------------- | ||
|
|
||
| namespace COMET.Web.Common.Extensions | ||
| { | ||
| using CDP4Common.EngineeringModelData; | ||
| using CDP4Common.SiteDirectoryData; | ||
|
|
||
| using COMET.Web.Common.Services.SessionManagement; | ||
|
|
||
| using FluentResults; | ||
|
|
||
| /// <summary> | ||
| /// Static class with extension methods for the <see cref="ISessionService"/> | ||
| /// </summary> | ||
| public static class SessionServiceExtensions | ||
| { | ||
| /// <summary> | ||
| /// Adds a new parameter for a given element definition | ||
| /// </summary> | ||
| /// <param name="sessionService">The <see cref="ISessionService"/> in which data will be updated</param> | ||
| /// <param name="elementDefinition">The <see cref="ElementDefinition"/> in which a new parameter will be added</param> | ||
| /// <param name="group">The <see cref="ParameterGroup"/> of the new parameter</param> | ||
| /// <param name="parameterType">The <see cref="ParameterType"/> of the new parameter</param> | ||
| /// <param name="measurementScale">The <see cref="MeasurementScale"/> of the new parameter</param> | ||
| /// <param name="owner">The <see cref="DomainOfExpertise"/> of the owner</param> | ||
| /// <returns>A <see cref="Task"/></returns> | ||
| /// <exception cref="ArgumentNullException">Throws an <see cref="ArgumentNullException"/></exception> | ||
| public static async Task<Result> AddParameter(this ISessionService sessionService, ElementDefinition elementDefinition, ParameterGroup group, ParameterType parameterType, MeasurementScale measurementScale, DomainOfExpertise owner) | ||
| { | ||
| if (elementDefinition == null) | ||
| { | ||
| throw new ArgumentNullException(nameof(elementDefinition), "The container ElementDefinition may not be null"); | ||
| } | ||
|
|
||
| if (parameterType == null) | ||
| { | ||
| throw new ArgumentNullException(nameof(parameterType), "The ParameterType may not be null"); | ||
| } | ||
|
|
||
| if (owner == null) | ||
| { | ||
| throw new ArgumentNullException(nameof(owner), "The owner DomainOfExpertise may not be null"); | ||
| } | ||
|
|
||
| if (sessionService.Session == null) | ||
| { | ||
| throw new ArgumentNullException(nameof(sessionService.Session), "The session may not be null"); | ||
| } | ||
|
|
||
| var parameter = new Parameter(Guid.NewGuid(), null, null) | ||
| { | ||
| Owner = owner, | ||
| ParameterType = parameterType, | ||
| Scale = measurementScale, | ||
| Group = group, | ||
| ValueSet = { new ParameterValueSet() } | ||
| }; | ||
|
|
||
| var clone = elementDefinition.Clone(false); | ||
| clone.Parameter.Add(parameter); | ||
|
|
||
| return await sessionService.CreateThing(clone, parameter); | ||
| } | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.