Add feature to use opc-plc as nuget package (#325)

* Update nuget * Use langversion preview * Add pck icon * Add nuget config * Use async wait * Handle possible null * Add static dependencies and unpack to output folder * Cosmetic * Fix amb. namespace * Cosmetic * Incr version * Cosmetic * Fix typos and consistency * Fix typos and consistency * Sync readme CLI options * Fix typos * Simplify namespaces * Cosmetic * Add sample files * Update readme * Update ver
Azure-Samples · Dec 4, 2023 · dd2532c · dd2532c
1 parent 0cd1420
commit dd2532c
Show file tree

Hide file tree

Showing 13 changed files with 144 additions and 13 deletions.
diff --git a/README.md b/README.md
@@ -9,7 +9,6 @@ products:
 urlFragment: azure-iot-sample-opc-ua-server
 ---
 
-
 # OPC PLC server
 Implements an OPC-UA server with different nodes generating random data, anomalies and configuration of user defined nodes.
 
@@ -242,6 +241,13 @@ More information about this feature can be found [here](deterministic-alarms.md)
 | StartUpdateSlowNodes | Start the increase of value of slow nodes      | slow nodes activated                           |
 | StartUpdateFastNodes | Start the increase of value of fast nodes      | fast nodes activated                           |
 
+## NuGet
+- The OPC PLC build generates a NuGet package that can be used to add the OPC PLC server to your own project, e.g. for unit tests
+- Sample base class for unit tests: `./samples/OpcPlcBase.cs`
+- Sample unit test file that uses the base class: `./samples/OpcUaUnitTests.cs`
+- Sample NuGet config to consume a local package (needs to be next to the solution file): `./samples/nuget.config`
+- Sample project file that shows how to import the local OPC PLC nuget package: `./samples/OpcUaUnitTests.prj`
+
 ## Build
 The build scripts are for Azure DevOps and the container build is done in ACR. To use your own ACR you need to:
 

diff --git a/docs/media/icon.png b/docs/media/icon.png
diff --git a/samples/OpcPlcBase.cs b/samples/OpcPlcBase.cs
@@ -0,0 +1,54 @@
+namespace UnitTests;
+
+using System;
+using System.Linq;
+using System.Threading;
+using System.Threading.Tasks;
+
+public class OpcPlcBase
+{
+    public OpcPlcBase(string[] args, int port = 51234)
+    {
+        // Passed args override the following defaults.
+        var serverTask = Task.Run(() => OpcPlc.Program.MainAsync(
+            args.Concat(
+                new[]
+                {
+                    "--autoaccept",
+                    $"--portnum={port}",
+                    "--fn=25",
+                    "--fr=1",
+                    "--ft=uint",
+                }).ToArray(),
+            CancellationToken.None)
+            .GetAwaiter().GetResult());
+
+        OpcPlcEndpointUrl = WaitForServerUpAsync(serverTask).GetAwaiter().GetResult();
+    }
+
+    public string OpcPlcEndpointUrl { get; }
+
+    private static async Task<string> WaitForServerUpAsync(Task serverTask)
+    {
+        while (true)
+        {
+            if (serverTask.IsFaulted)
+            {
+                throw serverTask.Exception!;
+            }
+
+            if (serverTask.IsCompleted)
+            {
+                throw new Exception("Server failed to start.");
+            }
+
+            if (!OpcPlc.Program.Ready)
+            {
+                await Task.Delay(1000).ConfigureAwait(false);
+                continue;
+            }
+
+            return OpcPlc.Program.PlcServer.GetEndpoints()[0].EndpointUrl;
+        }
+    }
+}
diff --git a/samples/OpcUaUnitTests.cs b/samples/OpcUaUnitTests.cs
@@ -0,0 +1,22 @@
+namespace UnitTests;
+
+using System.Threading.Tasks;
+
+public class OpcUaUnitTests : OpcPlcBase
+{
+    public OpcUaUnitTests()
+        : base(new[] { "--gn=2" }) // Additional arguments.
+    {
+    }
+
+    [Test]
+    public async Task TestConnectedClientSession()
+    {
+        var opcUaClient = await OpcUaClientFactory
+            .GetConnectedClient(OpcPlcEndpointUrl)
+            .ConfigureAwait(false);
+
+        opcUaClient.Session.Connected.Should().BeTrue();
+        opcUaClient.Session.Close();
+    }
+}
diff --git a/samples/OpcUaUnitTests.prj b/samples/OpcUaUnitTests.prj
@@ -0,0 +1,7 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <ItemGroup>
+    <PackageReference Include="Microsoft.IoTEdge.OpcPlc" Version="2.10.0-gdd6f023a37" />
+  </ItemGroup>
+
+</Project>
diff --git a/samples/nuget.config b/samples/nuget.config
@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="utf-8"?>
+<configuration>
+  <packageSources>
+    <clear />
+    <add key="nuget.org" value="https://api.nuget.org/v3/index.json" />
+    <add key="LocalPackages" value="./packages" />
+  </packageSources>
+</configuration>
diff --git a/src/Microsoft.IoTEdge.OpcPlc.targets b/src/Microsoft.IoTEdge.OpcPlc.targets
@@ -0,0 +1,8 @@
+<Project>
+  <ItemGroup>
+    <Files Include="$(MSBuildThisFileDirectory)/../contentFiles/**/*.*" />
+  </ItemGroup>
+  <Target Name="CopyFiles" AfterTargets="Build">
+    <Copy SourceFiles="@(Files)" DestinationFolder="$(TargetDir)/%(RecursiveDir)" />
+  </Target>
+</Project>
diff --git a/src/Program.cs b/src/Program.cs
@@ -344,7 +344,7 @@ private static void InitLogging()
             return;
         }
 
-        LogLevel logLevel = LogLevel.Information;
+        LogLevel logLevel;
 
         // set the log level
         switch (LogLevelCli)
@@ -402,8 +402,8 @@ public static IHost CreateHostBuilder(string[] args)
             }).Build();
 
         return host;
-    }
-
+    }
+
     private static void LogLogo()
     {
         Logger.LogInformation(

diff --git a/src/opc-plc.csproj b/src/opc-plc.csproj
@@ -4,11 +4,20 @@
     <TargetFramework>net8.0</TargetFramework>
     <AssemblyName>opcplc</AssemblyName>
     <OutputType>Exe</OutputType>
-    <PackageId>OpcPlc</PackageId>
+    <IsPackable>true</IsPackable>
+    <PackageId>Microsoft.IoTEdge.OpcPlc</PackageId>
     <Authors>Microsoft</Authors>
+    <Version>1.0.0</Version>
     <RootNamespace>OpcPlc</RootNamespace>
     <UserSecretsId>bdf7b209-fef3-44d4-9aba-17035fda5efd</UserSecretsId>
-    <LangVersion>10.0</LangVersion>
+    <LangVersion>Preview</LangVersion>
+    <GeneratePackageOnBuild>True</GeneratePackageOnBuild>
+    <Title>Microsoft IoT Edge OPC PLC server</Title>
+    <Product>Azure Industrial IoT OPC UA PLC Server</Product>
+    <Description>Implements an OPC-UA server with different nodes generating random data, anomalies and configuration of user defined nodes.</Description>
+    <RepositoryUrl>https://github.com/Azure-Samples/iot-edge-opc-plc</RepositoryUrl>
+    <PackageOutputPath>$(OutputPath)</PackageOutputPath>
+    <PackageIcon>icon.png</PackageIcon>
   </PropertyGroup>
 
   <ItemGroup>
@@ -68,4 +77,20 @@
     <Folder Include="AlarmCondition\UnderlyingSystem\" />
   </ItemGroup>
 
+  <ItemGroup>
+    <Content Include="Microsoft.IoTEdge.OpcPlc.targets" PackagePath="build/Microsoft.IoTEdge.OpcPlc.targets" />
+    <Content Include="Boilers/**/*.*" copyToOutput="true">
+      <PackagePath>contentFiles\Boilers</PackagePath>
+    </Content>
+    <Content Include="CompanionSpecs/**/*.*" copyToOutput="true">
+      <PackagePath>contentFiles\CompanionSpecs</PackagePath>
+    </Content>
+    <Content Include="SimpleEvent/**/*.*" copyToOutput="true">
+      <PackagePath>contentFiles\SimpleEvent</PackagePath>
+    </Content>
+    <Content Include="nodesfile.json" copyToOutput="true">
+      <PackagePath>contentFiles</PackagePath>
+    </Content>
+  </ItemGroup>
+
 </Project>
diff --git a/tests/PlcSimulatorFixture.cs b/tests/PlcSimulatorFixture.cs
@@ -134,7 +134,7 @@ public async Task StartAsync()
             _serverCancellationTokenSource.Token)
             .GetAwaiter().GetResult());
 
-        string endpointUrl = WaitForServerUp();
+        string endpointUrl = await WaitForServerUpAsync().ConfigureAwait(false);
         await _log.WriteAsync($"Found server at: {endpointUrl}").ConfigureAwait(false);
 
         if (RuntimeInformation.IsOSPlatform(OSPlatform.OSX))
@@ -284,7 +284,7 @@ private ConfiguredEndpoint GetServerEndpoint(string endpointUrl)
         }
     }
 
-    private string WaitForServerUp()
+    private async Task<string> WaitForServerUpAsync()
     {
         while (true)
         {
@@ -295,13 +295,13 @@ private string WaitForServerUp()
 
             if (_serverTask.IsCompleted)
             {
-                throw new Exception("Server failed to start");
+                throw new Exception("Server failed to start.");
             }
 
             if (!Program.Ready)
             {
-                _log.WriteLine("Waiting for server to start...");
-                Thread.Sleep(1000);
+                _log.WriteLine("Waiting for server to start ...");
+                await Task.Delay(1000).ConfigureAwait(false);
                 continue;
             }
 

diff --git a/tests/SimulatorTestsBase.cs b/tests/SimulatorTestsBase.cs
@@ -48,7 +48,7 @@ public async Task Setup()
     [OneTimeTearDown]
     public async Task TearDown()
     {
-        Session.Close();
+        Session?.Close();
         await _simulator.StopAsync().ConfigureAwait(false);
     }
 

diff --git a/tests/opc-plc-tests.csproj b/tests/opc-plc-tests.csproj
@@ -4,6 +4,7 @@
     <TargetFramework>net8.0</TargetFramework>
     <RootNamespace>OpcPlc.Tests</RootNamespace>
     <IsPackable>false</IsPackable>
+    <LangVersion>Preview</LangVersion>
   </PropertyGroup>
 
   <ItemGroup>

diff --git a/version.json b/version.json
@@ -1,6 +1,6 @@
 {
   "$schema": "https://raw.githubusercontent.com/AArnott/Nerdbank.GitVersioning/master/src/NerdBank.GitVersioning/version.schema.json",
-  "version": "2.9.15",
+  "version": "2.10.0",
   "versionHeightOffset": -1,
   "publicReleaseRefSpec": [
     "^refs/heads/main$",