Metadata cleanup. Approval. Synchronization.

.github/workflows/dotnet.yml

@@ -69,6 +69,12 @@ jobs:
     - name: Restore dependencies CloudLibClientTests
       run: dotnet restore
       working-directory: Tests/CloudLibClientTests
+    - name: Restore dependencies CloudLibSync
+      working-directory: CloudLibSync
+      run: dotnet restore
+    - name: Restore dependencies CloudLibSyncAzureFunction
+      working-directory: CloudLibSyncAzureFunction
+      run: dotnet restore
     - name: Build
       run: dotnet build UA-CloudLibrary.sln --configuration Release --no-restore
     - name: Test

CloudLibSync/CloudLibSync.csproj

@@ -0,0 +1,17 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <OutputType>Exe</OutputType>
+    <TargetFramework>net6.0</TargetFramework>
+    <ImplicitUsings>enable</ImplicitUsings>
+    <Nullable>enable</Nullable>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <ProjectReference Include="..\Opc.Ua.CloudLib.Client\Opc.Ua.Cloud.Library.Client.csproj" />
+	  <PackageReference Include="OPCFoundation.NetStandard.Opc.Ua.Core" Version="1.4.370.12" />
+	  <PackageReference Include="System.CommandLine" Version="2.0.0-beta3.22114.1" />
+	  <PackageReference Include="System.CommandLine.NamingConventionBinder" Version="2.0.0-beta3.22114.1" />
+  </ItemGroup>
+
+</Project>

CloudLibSync/Program.cs

@@ -0,0 +1,73 @@
+using System.CommandLine;
+using System.CommandLine.NamingConventionBinder;
+using Microsoft.Extensions.Logging;
+using Opc.Ua.CloudLib.Sync;
+
+class Program : ILogger
+{
+    public static Task<int> Main(string[] args)
+    {
+        return new Program().MainAsync(args);
+    }
+
+    public async Task<int> MainAsync(string[] args)
+    {
+        var downloadCommand = new Command("download", "Downloads all nodesets and their metadata from a Cloud Library to a local directory.")
+        {
+              new Argument<string>("sourceUrl") {},
+              new Argument<string>("sourceUserName") {},
+              new Argument<string>("sourcePassword") {},
+              new Option<string>("--localDir", () => "Downloads") { },
+              new Option<string>("--nodeSetXmlDir", "If specified the node sets without their metadata (XML only) will be written to this directory.") { },
+        };
+        downloadCommand.Handler = CommandHandler.Create(new CloudLibSync(this).DownloadAsync);
+
+        var syncCommand = new Command("sync", "Downloads all nodests and their metadata from a Cloud Library (source) and uploads it to another Cloud Library (target).")
+        {
+              new Argument<string>("sourceUrl") {},
+              new Argument<string>("sourceUserName") {},
+              new Argument<string>("sourcePassword") { },
+              new Argument<string>("targetUrl") { },
+              new Argument<string>("targetUserName") {},
+              new Argument<string>("targetPassword") {},
+        };
+        syncCommand.Handler = CommandHandler.Create(new CloudLibSync(this).SynchronizeAsync);
+
+
+        var uploadCommand = new Command("upload", "Uploads nodesets and their metadata from a local directory to a cloud library.")
+            {
+              new Argument<string>("targetUrl") {},
+              new Argument<string>("targetUserName") {},
+              new Argument<string>("targetPassword") {},
+              new Option<string>("--localDir", () => "Downloads") {},
+              new Option<string>("--fileName", "If specified, uploads only this nodeset file. Otherwise all files in --localDir are uploaded.") {},
+            };
+        uploadCommand.Handler = CommandHandler.Create(new CloudLibSync(this).UploadAsync);
+
+        var root = new RootCommand()
+        {
+            syncCommand,
+            downloadCommand,
+            uploadCommand,
+        };
+
+        await root.InvokeAsync(args);
+
+        return 0;
+    }
+
+    public void Log<TState>(LogLevel logLevel, EventId eventId, TState state, Exception? exception, Func<TState, Exception?, string> formatter)
+    {
+        Console.WriteLine(formatter(state, exception));
+    }
+
+    public bool IsEnabled(LogLevel logLevel)
+    {
+        return true;
+    }
+
+    public IDisposable BeginScope<TState>(TState state)
+    {
+        return new MemoryStream();
+    }
+}

CloudLibSyncAzureFunction/CloudLibSyncAzureFunction.csproj

@@ -0,0 +1,22 @@
+<Project Sdk="Microsoft.NET.Sdk">
+  <PropertyGroup>
+    <TargetFramework>net6.0</TargetFramework>
+    <AzureFunctionsVersion>v4</AzureFunctionsVersion>
+  </PropertyGroup>
+  <ItemGroup>
+    <PackageReference Include="Microsoft.Azure.Functions.Extensions" Version="1.1.0" />
+    <PackageReference Include="Microsoft.NET.Sdk.Functions" Version="4.0.1" />
+  </ItemGroup>
+  <ItemGroup>
+    <ProjectReference Include="..\CloudLibSync\CloudLibSync.csproj" />
+  </ItemGroup>
+  <ItemGroup>
+    <None Update="host.json">
+      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+    </None>
+    <None Update="local.settings.json">
+      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+      <CopyToPublishDirectory>Never</CopyToPublishDirectory>
+    </None>
+  </ItemGroup>
+</Project>

CloudLibSyncAzureFunction/CloudSyncFunction.cs

@@ -0,0 +1,66 @@
+using System;
+using System.Threading.Tasks;
+using Microsoft.Azure.Functions.Extensions.DependencyInjection;
+using Microsoft.Azure.WebJobs;
+using Microsoft.Azure.WebJobs.Host;
+using Microsoft.Extensions.Configuration;
+using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.Logging;
+using Microsoft.Extensions.Options;
+using Opc.Ua.Cloud.Library.Client;
+using Opc.Ua.CloudLib.Sync;
+
+[assembly: FunctionsStartup(typeof(CloudLibSyncAzureFunction.CloudSyncFunctionStartup))]
+
+namespace CloudLibSyncAzureFunction
+{
+
+    public class CloudLibSyncOptions
+    {
+        public UACloudLibClient.Options Source { get; set; }
+        public UACloudLibClient.Options Target { get; set; }
+    }
+
+    public class CloudSyncFunctionStartup : FunctionsStartup
+    {
+        public override void Configure(IFunctionsHostBuilder builder)
+        {
+            builder.Services
+                .AddOptions<CloudLibSyncOptions>()
+                    .Configure<IConfiguration>((settings, configuration) => {
+                        configuration.GetSection("CloudLibrarySync").Bind(settings);
+                    });
+        }
+    }
+
+    public class CloudSyncFunction
+    {
+        public CloudSyncFunction(IOptions<CloudLibSyncOptions> options)
+        {
+            if (options == null || options.Value == null)
+            {
+                throw new ArgumentNullException(nameof(CloudLibSyncOptions));
+            }
+            if (options.Value.Source == null)
+            {
+                throw new ArgumentNullException(nameof(options.Value.Source));
+            }
+            if (options.Value.Target == null)
+            {
+                throw new ArgumentNullException(nameof(options.Value.Target));
+            }
+            _options = options.Value;
+        }
+        readonly CloudLibSyncOptions _options;
+
+        [FunctionName("CloudSyncFunction")]
+        public async Task Run([TimerTrigger("0 0 5 * * *", RunOnStartup = true)] TimerInfo myTimer, ILogger log)
+        {
+            log.LogInformation($"C# Timer trigger function executed at: {DateTime.Now}");
+            await new CloudLibSync(log).SynchronizeAsync(
+                _options.Source.EndPoint, _options.Source.Username, _options.Source.Password,
+                _options.Target.EndPoint, _options.Target.Username, _options.Target.Password).ConfigureAwait(false);
+        }
+    }
+}
+

CloudLibSyncAzureFunction/Properties/serviceDependencies.json

@@ -0,0 +1,11 @@
+{
+  "dependencies": {
+    "appInsights1": {
+      "type": "appInsights"
+    },
+    "storage1": {
+      "type": "storage",
+      "connectionId": "AzureWebJobsStorage"
+    }
+  }
+}

CloudLibSyncAzureFunction/Properties/serviceDependencies.local.json

@@ -0,0 +1,11 @@
+{
+  "dependencies": {
+    "appInsights1": {
+      "type": "appInsights.sdk"
+    },
+    "storage1": {
+      "type": "storage.emulator",
+      "connectionId": "AzureWebJobsStorage"
+    }
+  }
+}

CloudLibSyncAzureFunction/host.json

@@ -0,0 +1,12 @@
+{
+  "version": "2.0",
+  "functionTimeout": "00:10:00",
+  "logging": {
+    "applicationInsights": {
+      "samplingSettings": {
+        "isEnabled": true,
+        "excludedTypes": "Request"
+      }
+    }
+  }
+}

CloudLibSyncAzureFunction/local.settings.json

@@ -0,0 +1,7 @@
+{
+  "IsEncrypted": false,
+  "Values": {
+    "AzureWebJobsStorage": "UseDevelopmentStorage=true",
+    "FUNCTIONS_WORKER_RUNTIME": "dotnet"
+  }
+}

CloudLibSyncAzureFunction/readme.md

@@ -0,0 +1,21 @@
+To configure the CloudLib Sync function, credentials for the source and target cloud libraries need to be provided.
+
+For cloud hosting, add them in in the Azure portal.
+
+For local development, add them to the local.settings.json:
+
+```json
+{
+  "Values": {
+     // ...
+    "CloudLibrarySync:Source:Url": "https://uacloudlibrary.opcfoundation.org/",
+    "CloudLibrarySync:Source:Username": "<yourUsername>",
+    "CloudLibrarySync:Source:Password": "<yourPassword>",
+    "CloudLibrarySync:Target:Url": "https://localhost:5001/",
+    "CloudLibrarySync:Target:Username": "<yourOtherUsername>",
+    "CloudLibrarySync:Target:Password": "<yourOtherPassword>"
+  }
+}
+```
+
+tail -f LogFiles/Application/Functions/Function/CloudSyncFunction/*

Opc.Ua.CloudLib.Client/GraphQlExtensions.cs

@@ -0,0 +1,46 @@
+/* ========================================================================
+ * Copyright (c) 2005-2021 The OPC Foundation, Inc. All rights reserved.
+ *
+ * OPC Foundation MIT License 1.00
+ *
+ * Permission is hereby granted, free of charge, to any person
+ * obtaining a copy of this software and associated documentation
+ * files (the "Software"), to deal in the Software without
+ * restriction, including without limitation the rights to use,
+ * copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the
+ * Software is furnished to do so, subject to the following
+ * conditions:
+ *
+ * The above copyright notice and this permission notice shall be
+ * included in all copies or substantial portions of the Software.
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+ * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+ * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+ * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+ * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+ * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+ * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+ * OTHER DEALINGS IN THE SOFTWARE.
+ *
+ * The complete license agreement can be found here:
+ * http://opcfoundation.org/License/MIT/1.00/
+ * ======================================================================*/
+
+namespace Opc.Ua.Cloud.Library.Client
+{
+    using System;
+    using GraphQL.Query.Builder;
+
+    static class GraphQlExtensions
+    {
+        public static IQuery<TSource> AddFields<TSource>(this IQuery<TSource> This, Func<IQuery<TSource>, IQuery<TSource>> addFields, bool skip = false)
+        {
+            if (skip)
+            {
+                return This;
+            }
+            return addFields(This);
+        }
+    }
+}