Add API Test Project

.github/workflows/run_newman.yml

@@ -0,0 +1,43 @@
+name: newman_tests
+
+on:
+  push
+  #workflow_dispatch
+
+jobs:
+  api-test:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Setup .NET
+      uses: actions/setup-dotnet@v1
+      with:
+        dotnet-version: 3.1.x
+    - name: Setup Node
+      uses: actions/setup-node@v1
+      with:
+        node-version: 12.x
+    - name: Install Newman and HTML Reporter
+      run: |
+       npm install -g [email protected]
+       npm install -g [email protected]
+    - name: Restore dependencies
+      run: dotnet restore ./src/AasxServerBlazor/AasxServerBlazor.csproj
+    - name: Build
+      run: dotnet build ./src/AasxServerBlazor/AasxServerBlazor.csproj -c Release -o ./build
+    - name: Start Test Server And Execute Test Scripts
+      run: |
+       cd build
+       dotnet ./AasxServerBlazor.dll --aspnet --data-path ../test/rest_api/data &
+       sleep 10
+       cd ..
+       newman run ./test/rest_api/postman/SubmodelElementTest.json.postman_collection -e ./test/rest_api/postman/GitHubActionEnvironment.json.postman_environment --reporters cli,htmlextra --reporter-htmlextra-export report.html --insecure
+       kill -9 `lsof -i:5001 -t`
+    - name: Upload Report
+      uses: actions/upload-artifact@v2
+      if: always()
+      with:
+        name: report.html
+        path: ./report.html

README.md

@@ -10,7 +10,7 @@ https://github.com/admin-shell-io/aasx-server/workflows/Build-and-publish-docker
 )
 
 AASX Server serves Industrie 4.0 AASX packages accessible by REST, OPC UA and
-MQTT protocols.
+MQTT protocols..
 
 The AASX Server is based on code of AASX Package Explorer (
 https://github.com/admin-shell-io/aasx-package-explorer

src/AasxServer.sln

@@ -24,6 +24,10 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "IO.Swagger.Lib", "IO.Swagge
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "IO.Swagger.Registry", "IO.Swagger.Registry.Lib\IO.Swagger.Registry.csproj", "{F7B9E4DC-FDCD-4F6B-A5C5-DF416802B067}"
 EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "IO.Swagger", "IO.Swagger\IO.Swagger.csproj", "{478697A0-89E4-4039-902E-0F13EA4EAD72}"
+EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "IO.Swagger.Test", "IO.Swagger.Test\IO.Swagger.Test.csproj", "{1E721E5E-6E56-4E2C-A8ED-AB381B6C7E8A}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU

src/AasxServerBlazor/AasxServerBlazor.csproj

@@ -24,8 +24,6 @@
     <ProjectReference Include="..\IO.Swagger.Registry.Lib\IO.Swagger.Registry.csproj" />
   </ItemGroup>
 
-  <ProjectExtensions><VisualStudio><UserProperties appsettings_1json__JsonSchema="Url&quot;" /></VisualStudio></ProjectExtensions>
-
   <ItemGroup>
     <Content Include="startForDemo.sh">
       <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>

src/AasxServerBlazor/Program.cs

@@ -19,12 +19,19 @@ public static void Main(string[] args)
         {
             Console.WriteLine(Directory.GetCurrentDirectory());
 
+            //TODO DELETE this piece of code make wrong assumptions about the current directory
+            /*
             var config = new ConfigurationBuilder()
                 .SetBasePath(Directory.GetCurrentDirectory())
                 .AddJsonFile("appsettings.json").Build();
+            */
+
+            //TODO REFACTOR it is not ensured that this is the actual endpoint. Why is this information needed so early in the lifecycle?
+            /*
             string[] url = config["Kestrel:Endpoints:Http:Url"].Split(':');
             if (url[2] != null)
-                AasxServer.Program.blazorPort = url[2];
+                AasxServer.Program.blazorHostPort = url[2];
+            */
 
             CreateHostBuilder(args).Build().RunAsync();
 
@@ -38,7 +45,8 @@ public static IHostBuilder CreateHostBuilder(string[] args) =>
                 {
                     webBuilder
                         .UseStartup<Startup>()
-                        .UseUrls("http://*:5000")
+                    //TODO CHECK why is a manuel override used? server does not uses same port consistently (sometimes 5000, sometimes port specified in appconfig.json) across different platforms
+                    //.UseUrls("http://*:5000")
                     /*
                     .UseKestrel(options =>
                     {

src/AasxServerBlazor/Properties/launchSettings.json

@@ -18,7 +18,17 @@
     },
     "AasxServerBlazor": {
       "commandName": "Project",
-      "commandLineArgs": "--rest --no-security --data-path \"C:\\Development\\PCF\" --edit --external-blazor http://localhost:5001",
+      "commandLineArgs": "--aspnet --no-security --data-path \"C:\\Development\\AASX\" --edit --external-blazor http://localhost:5001",
+      "launchBrowser": true,
+      "environmentVariables": {
+        "ASPNETCORE_ENVIRONMENT": "Development"
+      },
+      "applicationUrl": "http://localhost:5001",
+      "jsWebView2Debugging": true
+    },
+    "TestRestApi": {
+      "commandName": "Project",
+      "commandLineArgs": "--aspnet --no-security --data-path \"..\\..\\test\\rest_api\\data\" --edit --external-blazor http://localhost:5001",
       "launchBrowser": true,
       "environmentVariables": {
         "ASPNETCORE_ENVIRONMENT": "Development"

src/AasxServerStandardBib/Program.cs

@@ -169,6 +169,7 @@ private class CommandLineArguments
             public bool Rest { get; set; }
             public bool Opc { get; set; }
             public bool Mqtt { get; set; }
+            public bool AspNet { get; set; }//hack solution to start without grapevine
             public bool DebugWait { get; set; }
             public int? OpcClientRate { get; set; }
             public string[] Connect { get; set; }
@@ -474,6 +475,11 @@ private static int Run(CommandLineArguments a)
                     envi++;
                 }
             }
+            else
+            {
+                Console.WriteLine($"AASX Data Path does not exist. \n\tCurrent Dir\t{Directory.GetCurrentDirectory()}\n\tAASX Data Path\t{AasxHttpContextHelper.DataPath}");
+                throw new Exception("Invalid AASX Data Path.");
+            }
 
             AasxHttpContextHelper.securityInit(); // read users and access rights form AASX Security
             AasxHttpContextHelper.serverCertsInit(); // load certificates of auth servers
@@ -695,6 +701,10 @@ public static void Main(string[] args)
                     new[] {"--mqtt"},
                     "If set, starts a MQTT publisher"),
 
+                new Option<bool>(
+                    new[] {"--aspnet"},
+                    "If set, app is running using aspnet framework"),
+
                 new Option<bool>(
                     new[] {"--debug-wait"},
                     "If set, waits for Debugger to attach"),
@@ -704,6 +714,7 @@ public static void Main(string[] args)
                     "If set, starts an OPC client and refreshes on the given period " +
                     "(in milliseconds)"),
 
+                //TODO CHECK is the connect feature legacy code from Package Explorer?
                 new Option<string[]>(
                     new[] {"--connect"},
                     "If set, connects to AAS connect server. " +
@@ -755,7 +766,7 @@ public static void Main(string[] args)
             rootCommand.Handler = System.CommandLine.Invocation.CommandHandler.Create(
                 (CommandLineArguments a) =>
                 {
-                    if (!(a.Rest || a.Opc || a.Mqtt))
+                    if (!(a.Rest || a.Opc || a.Mqtt || a.AspNet))
                     {
                         Console.Error.WriteLine($"Please specify --rest and/or --opc and/or --mqtt{nl}");
                         new HelpBuilder(new SystemConsole()).Write(rootCommand);
@@ -979,6 +990,7 @@ public static void connectPublish(string type, string json)
 
         public static void connectThreadLoop()
         {
+            //TODO CHECK is this leagy code?
             bool newConnectData = false;
 
             while (connectLoop)

src/IO.Swagger/.gitignore

@@ -0,0 +1,208 @@
+PID
+
+## Ignore Visual Studio temporary files, build results, and
+## files generated by popular Visual Studio add-ons.
+
+# User-specific files
+*.suo
+*.user
+*.userosscache
+*.sln.docstates
+
+# User-specific files (MonoDevelop/Xamarin Studio)
+*.userprefs
+
+# Build results
+[Dd]ebug/
+[Dd]ebugPublic/
+[Rr]elease/
+[Rr]eleases/
+x64/
+x86/
+build/
+bld/
+[Bb]in/
+[Oo]bj/
+
+# Visual Studio 2015 cache/options directory
+.vs/
+
+# MSTest test Results
+[Tt]est[Rr]esult*/
+[Bb]uild[Ll]og.*
+
+# NUNIT
+*.VisualState.xml
+TestResult.xml
+
+# Build Results of an ATL Project
+[Dd]ebugPS/
+[Rr]eleasePS/
+dlldata.c
+
+# DNX
+project.lock.json
+artifacts/
+
+*_i.c
+*_p.c
+*_i.h
+*.ilk
+*.meta
+*.obj
+*.pch
+*.pdb
+*.pgc
+*.pgd
+*.rsp
+*.sbr
+*.tlb
+*.tli
+*.tlh
+*.tmp
+*.tmp_proj
+*.log
+*.vspscc
+*.vssscc
+.builds
+*.pidb
+*.svclog
+*.scc
+
+# Chutzpah Test files
+_Chutzpah*
+
+# Visual C++ cache files
+ipch/
+*.aps
+*.ncb
+*.opensdf
+*.sdf
+*.cachefile
+
+# Visual Studio profiler
+*.psess
+*.vsp
+*.vspx
+
+# TFS 2012 Local Workspace
+$tf/
+
+# Guidance Automation Toolkit
+*.gpState
+
+# ReSharper is a .NET coding add-in
+_ReSharper*/
+*.[Rr]e[Ss]harper
+*.DotSettings.user
+
+# JustCode is a .NET coding add-in
+.JustCode
+
+# TeamCity is a build add-in
+_TeamCity*
+
+# DotCover is a Code Coverage Tool
+*.dotCover
+
+# NCrunch
+_NCrunch_*
+.*crunch*.local.xml
+
+# MightyMoose
+*.mm.*
+AutoTest.Net/
+
+# Web workbench (sass)
+.sass-cache/
+
+# Installshield output folder
+[Ee]xpress/
+
+# DocProject is a documentation generator add-in
+DocProject/buildhelp/
+DocProject/Help/*.HxT
+DocProject/Help/*.HxC
+DocProject/Help/*.hhc
+DocProject/Help/*.hhk
+DocProject/Help/*.hhp
+DocProject/Help/Html2
+DocProject/Help/html
+
+# Click-Once directory
+publish/
+
+# Publish Web Output
+*.[Pp]ublish.xml
+*.azurePubxml
+# TODO: Comment the next line if you want to checkin your web deploy settings
+# but database connection strings (with potential passwords) will be unencrypted
+*.pubxml
+*.publishproj
+
+# NuGet Packages
+*.nupkg
+# The packages folder can be ignored because of Package Restore
+**/packages/*
+# except build/, which is used as an MSBuild target.
+!**/packages/build/
+# Uncomment if necessary however generally it will be regenerated when needed
+#!**/packages/repositories.config
+
+# Windows Azure Build Output
+csx/
+*.build.csdef
+
+# Windows Store app package directory
+AppPackages/
+
+# Visual Studio cache files
+# files ending in .cache can be ignored
+*.[Cc]ache
+# but keep track of directories ending in .cache
+!*.[Cc]ache/
+
+# Others
+ClientBin/
+[Ss]tyle[Cc]op.*
+~$*
+*~
+*.dbmdl
+*.dbproj.schemaview
+*.pfx
+*.publishsettings
+node_modules/
+bower_components/
+orleans.codegen.cs
+
+# RIA/Silverlight projects
+Generated_Code/
+
+# Backup & report files from converting an old project file
+# to a newer Visual Studio version. Backup files are not needed,
+# because we have git ;-)
+_UpgradeReport_Files/
+Backup*/
+UpgradeLog*.XML
+UpgradeLog*.htm
+
+# SQL Server files
+*.mdf
+*.ldf
+
+# Business Intelligence projects
+*.rdl.data
+*.bim.layout
+*.bim_*.settings
+
+# Microsoft Fakes
+FakesAssemblies/
+
+# Node.js Tools for Visual Studio
+.ntvs_analysis.dat
+
+# Visual Studio 6 build log
+*.plg
+
+# Visual Studio 6 workspace options file
+*.opt