Merge branch 'ThreeMammals:develop' into develop

.circleci/config.yml

@@ -1,16 +1,16 @@
 version: 2.1
 orbs:
-  queue: eddiewebb/queue@1.5.0
+  queue: eddiewebb/queue@2.2.1
 jobs:
   build:
     docker:
-      - image: mijitt0m/ocelot-build:0.0.6
+      - image: mijitt0m/ocelot-build:0.0.9
     steps:
       - checkout
       - run: dotnet tool restore && dotnet cake
   release:
     docker:
-      - image: mijitt0m/ocelot-build:0.0.6
+      - image: mijitt0m/ocelot-build:0.0.9
     steps:
       - checkout
       - run: dotnet tool restore && dotnet cake --target=Release

.config/dotnet-tools.json

@@ -3,13 +3,13 @@
   "isRoot": true,
   "tools": {
     "cake.tool": {
-      "version": "2.0.0",
+      "version": "3.0.0",
       "commands": [
         "dotnet-cake"
       ]
     },
     "coveralls.net": {
-      "version": "3.0.0",
+      "version": "4.0.1",
       "commands": [
         "csmacnz.Coveralls"
       ]

.gitignore

@@ -183,7 +183,7 @@ ClientBin/
 *.dbmdl
 *.dbproj.schemaview
 *.pfx
-!idsrv3test.pfx
+!mycert.pfx
 *.publishsettings
 node_modules/
 orleans.codegen.cs

Ocelot.sln

@@ -50,7 +50,7 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Ocelot.Provider.Kubernetes"
 EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "samples", "samples", "{8FA0CBA0-0338-48EB-B37F-83CA5022237C}"
 EndProject
-Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "OcelotBasic", "samples\OcelotBasic\OcelotBasic.csproj", "{ED0B3A09-112B-4BA4-82D6-11569BC7A99B}"
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Ocelot.Samples.OcelotBasic.ApiGateway", "samples\OcelotBasic\Ocelot.Samples.OcelotBasic.ApiGateway.csproj", "{ED0B3A09-112B-4BA4-82D6-11569BC7A99B}"
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "AdministrationApi", "samples\AdministrationApi\AdministrationApi.csproj", "{B180F8AE-2F8F-44F9-9E5D-FE65B84B742E}"
 EndProject
@@ -64,9 +64,9 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "DownstreamService", "sample
 EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "k8s", "k8s", "{4B706988-4817-43A8-ABE1-32A67998C2C8}"
 EndProject
-Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "ApiGateway", "samples\OcelotKube\ApiGateway\ApiGateway.csproj", "{8500055B-2C51-4CF1-A6EE-F05BB3E9BF16}"
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Ocelot.Samples.OcelotKube.ApiGateway", "samples\OcelotKube\ApiGateway\Ocelot.Samples.OcelotKube.ApiGateway.csproj", "{8500055B-2C51-4CF1-A6EE-F05BB3E9BF16}"
 EndProject
-Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "DownstreamService", "samples\OcelotKube\DownstreamService\DownstreamService.csproj", "{7B319B8C-8155-4779-BD93-5ABD05CA2AB6}"
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Ocelot.Samples.OcelotKube.DownstreamService", "samples\OcelotKube\DownstreamService\Ocelot.Samples.OcelotKube.DownstreamService.csproj", "{7B319B8C-8155-4779-BD93-5ABD05CA2AB6}"
 EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "service-fabric", "service-fabric", "{B412628F-C325-47E1-A8D9-873DE04C8AF5}"
 EndProject

README.md

@@ -1,10 +1,8 @@
- ![Ocelot Logo](/images/ocelot_logo.png)
+![Ocelot Logo](/images/ocelot_logo.png)
 
 [![CircleCI](https://circleci.com/gh/ThreeMammals/Ocelot/tree/main.svg?style=svg)](https://circleci.com/gh/ThreeMammals/Ocelot/tree/main)
 
-[![Coverage Status](https://coveralls.io/repos/github/ThreeMammals/Ocelot/badge.svg?branch=main)](https://coveralls.io/github/ThreeMammals/Ocelot?branch=main)
-
-[Slack](https://threemammals.slack.com)
+[![Coverage Status](https://coveralls.io/repos/github/ThreeMammals/Ocelot/badge.svg)](https://coveralls.io/github/ThreeMammals/Ocelot)
 
 # Ocelot
 
@@ -13,7 +11,7 @@ that need a unified point of entry into their system. However it will work with
 
 In particular I want easy integration with IdentityServer reference and bearer tokens. 
 
-We have been unable to find this in my current workplacewithout having to write our own Javascript middlewares to handle the IdentityServer reference tokens. We would rather use the IdentityServer code that already existsto do this.
+We have been unable to find this in my current workplace without having to write our own Javascript middlewares to handle the IdentityServer reference tokens. We would rather use the IdentityServer code that already exists to do this.
 
 Ocelot is a bunch of middlewares in a specific order.
 
@@ -43,7 +41,7 @@ A quick list of Ocelot's capabilities for more information see the [documentatio
 
 ## How to install
 
-Ocelot is designed to work with ASP.NET and it targets `net6.0`.
+Ocelot is designed to work with ASP.NET and it targets `net7.0`.
 
 Install Ocelot and it's dependencies using NuGet.
 

build.cake

@@ -1,10 +1,9 @@
 #tool "dotnet:?package=GitVersion.Tool&version=5.8.1"
-#tool "dotnet:?package=coveralls.net&version=3.0.0"
-#addin nuget:?package=Cake.Json&version=4.0.0
+#tool "dotnet:?package=coveralls.net&version=4.0.1"
 #addin nuget:?package=Newtonsoft.Json
 #addin nuget:?package=System.Text.Encodings.Web&version=4.7.1
-#tool "nuget:?package=ReportGenerator"
-#addin Cake.Coveralls&version=0.10.1
+#tool "nuget:?package=ReportGenerator&version=5.1.19"
+#addin Cake.Coveralls&version=1.1.0
 
 // compile
 var compileConfig = Argument("configuration", "Release");
@@ -178,7 +177,7 @@ Task("RunUnitTests")
 	.IsDependentOn("Compile")
 	.Does(() =>
 	{
-		var testSettings = new DotNetCoreTestSettings
+		var testSettings = new DotNetTestSettings
 		{
 			Configuration = compileConfig,
 			ResultsDirectory = artifactsForUnitTestsDir,
@@ -188,17 +187,15 @@ Task("RunUnitTests")
 		};
 
 		EnsureDirectoryExists(artifactsForUnitTestsDir);
-		DotNetCoreTest(unitTestAssemblies, testSettings);
+		DotNetTest(unitTestAssemblies, testSettings);
 
 		var coverageSummaryFile = GetSubDirectories(artifactsForUnitTestsDir).First().CombineWithFilePath(File("coverage.cobertura.xml"));
 		Information(coverageSummaryFile);
 		Information(artifactsForUnitTestsDir);
 
-		// todo bring back report generator to get a friendly report
-		// ReportGenerator(coverageSummaryFile, artifactsForUnitTestsDir);
-		// https://github.com/danielpalme/ReportGenerator
+		GenerateReport(coverageSummaryFile);
 
-		if (IsRunningOnCircleCI() && IsMain())
+		if (IsRunningOnCircleCI() && IsMainOrDevelop())
 		{
 			var repoToken = EnvironmentVariable(coverallsRepoToken);
 			if (string.IsNullOrEmpty(repoToken))
@@ -233,7 +230,7 @@ Task("RunAcceptanceTests")
 	.IsDependentOn("Compile")
 	.Does(() =>
 	{
-		var settings = new DotNetCoreTestSettings
+		var settings = new DotNetTestSettings
 		{
 			Configuration = compileConfig,
 			ArgumentCustomization = args => args
@@ -242,14 +239,14 @@ Task("RunAcceptanceTests")
 		};
 
 		EnsureDirectoryExists(artifactsForAcceptanceTestsDir);
-		DotNetCoreTest(acceptanceTestAssemblies, settings);
+		DotNetTest(acceptanceTestAssemblies, settings);
 	});
 
 Task("RunIntegrationTests")
 	.IsDependentOn("Compile")
 	.Does(() =>
 	{
-		var settings = new DotNetCoreTestSettings
+		var settings = new DotNetTestSettings
 		{
 			Configuration = compileConfig,
 			ArgumentCustomization = args => args
@@ -258,7 +255,7 @@ Task("RunIntegrationTests")
 		};
 
 		EnsureDirectoryExists(artifactsForIntegrationTestsDir);
-		DotNetCoreTest(integrationTestAssemblies, settings);
+		DotNetTest(integrationTestAssemblies, settings);
 	});
 
 Task("CreateArtifacts")
@@ -366,6 +363,21 @@ Task("PublishToNuget")
 
 RunTarget(target);
 
+private void GenerateReport(Cake.Core.IO.FilePath coverageSummaryFile)
+{
+	var dir = System.IO.Directory.GetCurrentDirectory();
+	Information(dir);
+
+	var reportSettings = new ProcessArgumentBuilder();
+	reportSettings.Append($"-targetdir:" + $"{dir}/{artifactsForUnitTestsDir}");
+	reportSettings.Append($"-reports:" + coverageSummaryFile);
+
+	var toolpath = Context.Tools.Resolve("net7.0/ReportGenerator.dll");
+	Information($"Tool Path : {toolpath.ToString()}");
+
+	DotNetExecute(toolpath, reportSettings);
+}
+
 /// Gets unique nuget version for this commit
 private GitVersion GetNuGetVersionForCommit()
 {
@@ -543,7 +555,19 @@ private bool IsRunningOnCircleCI()
     return !string.IsNullOrWhiteSpace(Environment.GetEnvironmentVariable("CIRCLECI"));
 }
 
-private bool IsMain()
+private bool IsMainOrDevelop()
 {
-    return Environment.GetEnvironmentVariable("CIRCLE_BRANCH").ToLower() == "main";
+	var env = Environment.GetEnvironmentVariable("CIRCLE_BRANCH").ToLower();
+
+	if(env == "main") 
+	{
+		return true;
+	}
+
+	if(env == "develop") 
+	{
+		return true;
+	}
+
+    return false;
 }

codeanalysis.ruleset

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="utf-8"?>
-<RuleSet Name="Rules for StyleCop.Analyzers" Description="Code analysis rules for StyleCop.Analyzers.csproj." ToolsVersion="15.0">
+<RuleSet Name="Rules for StyleCop.Analyzers" Description="Code analysis rules for StyleCop.Analyzers.csproj." ToolsVersion="17.0">
   <Rules AnalyzerId="AsyncUsageAnalyzers" RuleNamespace="AsyncUsageAnalyzers">
     <Rule Id="AvoidAsyncSuffix" Action="None" />
     <Rule Id="AvoidAsyncVoid" Action="Error" />
@@ -50,12 +50,11 @@
     <Rule Id="SA1209" Action="None" />
     <Rule Id="SA1210" Action="None" />
     <Rule Id="SA1214" Action="None" />
-    <Rule Id="SA1216" Action="None" />	
+    <Rule Id="SA1216" Action="None" />
     <Rule Id="SA1300" Action="None" />
     <Rule Id="SA1302" Action="Error" />
     <Rule Id="SA1303" Action="None" />
     <Rule Id="SA1304" Action="Error" />
-    <Rule Id="SA1305" Action="None" />
     <Rule Id="SA1309" Action="None" />
     <Rule Id="SA1310" Action="None" />
     <Rule Id="SA1311" Action="Error" />
@@ -70,14 +69,14 @@
     <Rule Id="SA1408" Action="None" />
     <Rule Id="SA1410" Action="Error" />
     <Rule Id="SA1411" Action="Error" />
-    <Rule Id="SA1412" Action="None" />
     <Rule Id="SA1500" Action="None" />
     <Rule Id="SA1502" Action="None" />
     <Rule Id="SA1516" Action="None" />
     <Rule Id="SA1600" Action="None" />
+    <Rule Id="SA1602" Action="None" />
     <Rule Id="SA1603" Action="Error" />
     <Rule Id="SA1609" Action="Error" />
-    <Rule Id="SA1611" Action="None" />	
+    <Rule Id="SA1611" Action="None" />
     <Rule Id="SA1623" Action="None" />
     <Rule Id="SA1633" Action="None" />
     <Rule Id="SA1636" Action="Error" />

docker/Dockerfile.base

@@ -1,10 +1,9 @@
-# syntax=docker/dockerfile:1
-FROM mcr.microsoft.com/dotnet/sdk:6.0-alpine
+FROM mcr.microsoft.com/dotnet/sdk:7.0-alpine
 
-RUN apk add bash icu-libs krb5-libs libgcc libintl libssl1.1 libstdc++ zlib
+RUN apk add bash icu-libs krb5-libs libgcc libintl libssl1.1 libstdc++ zlib git openssh-client
 
 RUN curl -L --output ./dotnet-install.sh https://dot.net/v1/dotnet-install.sh
 
 RUN chmod u+x ./dotnet-install.sh 
 
-RUN ./dotnet-install.sh -c 5.0 -i /usr/share/dotnet
+RUN ./dotnet-install.sh -c 6.0 -i /usr/share/dotnet

docker/Dockerfile.build

@@ -1,8 +1,7 @@
-# syntax=docker/dockerfile:1
 # call from ocelot repo root with
 # docker build --platform linux/arm64 --build-arg OCELOT_COVERALLS_TOKEN=$OCELOT_COVERALLS_TOKEN -f ./docker/Dockerfile.build .
 # docker build --platform linux/amd64 --build-arg OCELOT_COVERALLS_TOKEN=$OCELOT_COVERALLS_TOKEN -f ./docker/Dockerfile.build .
-FROM mijitt0m/ocelot-build:0.0.6
+FROM mijitt0m/ocelot-build:0.0.9
 
 ARG OCELOT_COVERALLS_TOKEN
 

docker/Dockerfile.release

@@ -1,8 +1,7 @@
-# syntax=docker/dockerfile:1
 # call from ocelot repo root with
 # docker build --platform linux/arm64 --build-arg OCELOT_COVERALLS_TOKEN=$OCELOT_COVERALLS_TOKEN --build-arg OCELOT_GITHUB_API_KEY=$OCELOT_GITHUB_API_KEY --build-arg OCELOT_COVERALLS_TOKEN=$OCELOT_COVERALLS_TOKEN -f ./docker/Dockerfile.build .
 # docker build --platform linux/amd64 --build-arg OCELOT_COVERALLS_TOKEN=$OCELOT_COVERALLS_TOKEN --build-arg OCELOT_GITHUB_API_KEY=$OCELOT_GITHUB_API_KEY --build-arg OCELOT_COVERALLS_TOKEN=$OCELOT_COVERALLS_TOKEN -f ./docker/Dockerfile.build .
-FROM mijitt0m/ocelot-build:0.0.6
+FROM mijitt0m/ocelot-build:0.0.9
 
 ARG OCELOT_COVERALLS_TOKEN
 ARG OCELOT_NUTGET_API_KEY

docker/build.sh

@@ -1,5 +1,5 @@
 # this script build the ocelot docker file
-version=0.0.6
+version=0.0.9
 docker build --platform linux/amd64 -t mijitt0m/ocelot-build -f Dockerfile.base .
 echo $DOCKER_PASS | docker login -u $DOCKER_USER --password-stdin
 docker tag mijitt0m/ocelot-build mijitt0m/ocelot-build:$version

docs/building/building.rst

@@ -7,4 +7,4 @@ Building
 
 * There is a Makefile to make it easier to call the various targers in `build.cake`. The scripts are called with .sh but can be easily changed to ps1 if you are using Windows.
 
-* Alternatively you can build the project in VS2022 with the latest .NET 6.0 SDK.
+* Alternatively you can build the project in VS2022 with the latest .NET 7.0 SDK.

docs/building/tests.rst

@@ -4,4 +4,15 @@ Tests
 The tests should all just run and work as part of the build process. You can of course also run them in visual studio.
 
 
+Create SSL Cert for Testing
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
+You can do this via openssl:
+
+Install openssl package (if you are using Windows, download binaries here).
+
+Generate private key: `openssl genrsa 2048 > private.pem`
+
+Generate the self signed certificate: `openssl req -x509 -days 1000 -new -key private.pem -out public.pem`
+
+If needed, create PFX: `openssl pkcs12 -export -in public.pem -inkey private.pem -out mycert.pfx`

docs/introduction/gettingstarted.rst

@@ -3,7 +3,7 @@ Getting Started
 
 Ocelot is designed to work with ASP.NET and is currently on net6.0.
 
-.NET 6.0
+.NET 7.0
 ^^^^^^^^
 
 **Install NuGet package**

samples/AdministrationApi/AdministrationApi.csproj

@@ -1,13 +1,13 @@
 <Project Sdk="Microsoft.NET.Sdk.Web">
   <PropertyGroup>
-    <TargetFramework>net6.0</TargetFramework>
+    <TargetFramework>net7.0</TargetFramework>
   </PropertyGroup>
   <ItemGroup>
     <Folder Include="wwwroot\" />
   </ItemGroup>
   <ItemGroup>
-    <PackageReference Include="Ocelot" Version="17.0.1" />
-    <PackageReference Include="Ocelot.Administration" Version="17.0.1" />
+    <PackageReference Include="Ocelot" Version="18.0.0" />
+    <PackageReference Include="Ocelot.Administration" Version="18.0.0" />
 
   </ItemGroup>
 </Project>

samples/AdministrationApi/Issue645.postman_collection.json

@@ -132,7 +132,7 @@
 				"id": "0f60e7b3-e4f1-4458-bbc4-fc4809e86b2d",
 				"type": "text/javascript",
 				"exec": [
-					""
+					string.Empty
 				]
 			}
 		},
@@ -142,7 +142,7 @@
 				"id": "1279a2cf-b771-4a86-9dfa-302b240fac62",
 				"type": "text/javascript",
 				"exec": [
-					""
+					string.Empty
 				]
 			}
 		}