Merge pull request #17 from localstack-dotnet/1.3.0 [skip ci]

v1.3.0

Author: Blind-Striker

LocalStack.sln

@@ -29,7 +29,6 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "_Solution Items", "_Solutio
 		build.sh = build.sh
 		src\Directory.Build.props = src\Directory.Build.props
 		.github\workflows\publish-nuget.yml = .github\workflows\publish-nuget.yml
-		.github\workflows\test-report.yml = .github\workflows\test-report.yml
 	EndProjectSection
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "LocalStack.Client.Extensions", "src\LocalStack.Client.Extensions\LocalStack.Client.Extensions.csproj", "{74035094-A726-44E2-9B88-42D6425D8548}"

README.md

@@ -27,6 +27,7 @@ application development.
         - [Installation](#extensions-installation)
         - [Usage](#extensions-usage)
         - [About AddAwsService](#extensions-usage-about-addawsservice)
+        - [useServiceUrl Parameter](#useserviceurl)
     - [Standalone Initialization](#standalone-initialization)
     - [Microsoft.Extensions.DependencyInjection Initialization](#di)
 5. [Developing](#developing)
@@ -143,7 +144,9 @@ You can configure `LocalStack.Client` by using entries in the `appsettings.json`
 All the entries above are has shown with default values (except `UseLocalStack`, it's `false` by default).
 So the above entries do not need to be specified.
 
-What is entered for the aws credential values ​​in the `Session` section does not matter for LocalStack. `RegionName` is important since LocalStack creates resources by spesified region.
+What is entered for the aws credential values ​​in the `Session` section does not matter for LocalStack.
+
+<a name="session-regioname"></a>`RegionName` is important since LocalStack creates resources by spesified region.
 
 `Config` section contains important entries for local development. Starting with LocalStack releases after `v0.11.5`, all services are now exposed via the edge service (port 4566) only! If you are using a version of LocalStack lower than v0.11.5, you should set `UseLegacyPorts` to `true`. Edge port can be set to any available port ([see LocalStack configuration section](https://github.com/localstack/localstack#configurations)). If you have made such a change in LocalStack's configuration, be sure to set the same port value to `EdgePort` in the `Config` section. For `LocalStackHost` and `UseSsl` entries, ​​corresponding to the [LocalStack configuration](https://github.com/localstack/localstack#configurations) should be used.
 
@@ -186,6 +189,28 @@ It is named as `AddAwsService` to avoid name conflict with `AddAWSService`.
 
 <e><b>(Alternatively, `AddAWSServiceLocalStack` method can be used to prevent mix-up with `AddAWSService`.)</b><e>
 
+#### <a name="useserviceurl"></a> useServiceUrl Parameter
+
+LocalStack.NET uses [ClientConfig](https://github.com/aws/aws-sdk-net/blob/master/sdk/src/Core/Amazon.Runtime/ClientConfig.cs) to configure AWS clients to connect LocalStack. `ClientConfig` has two properties called `ServiceUrl` and `RegionEndpoint`, these are mutually exclusive properties. Whichever property is set last will cause the other to automatically be reset to null. LocalStack.NET has given priority to the RegionEndpoint property and the `us-east-1` region is used as the default value (Different regions can be set by using appsettings.json, see [RegionName](#session-regioname) entry. Because of it sets the RegionEndpoint property after the ServiceUrl property, ServiceUrl will be set to null.
+
+To override this behavior, the `useServiceUrl` optional parameter can be set to `true` as below.
+
+```csharp
+public void ConfigureServices(IServiceCollection services)
+{
+    // Add framework services.
+    services.AddMvc();
+
+    services.AddLocalStack(Configuration)
+    services.AddDefaultAWSOptions(Configuration.GetAWSOptions());
+    services.AddAwsService<IAmazonS3>();
+    services.AddAwsService<IAmazonMediaStoreData>(useServiceUrl: true)
+    services.AddAwsService<IAmazonIoTJobsDataPlane>(useServiceUrl: true)
+}
+```
+
+The `RegionEndpoint` is not applicable for services such as AWS MediaStore, Iot. The optional parameter `useServiceUrl` can be useful for use in such scenarios.
+
 ### <a name="standalone-initialization"></a> Standalone Initialization
 
 If you do not want to use any DI library, you have to instantiate `SessionStandalone` as follows.
@@ -226,6 +251,32 @@ var amazonS3Client = session.CreateClientByImplementation<AmazonS3Client>();
 var amazonS3Client = session.CreateClientByInterface<IAmazonS3>();
 ```
 
+### <a name="standalone-useserviceurl"></a><b>useServiceUrl Parameter</b>
+
+LocalStack.NET uses [ClientConfig](https://github.com/aws/aws-sdk-net/blob/master/sdk/src/Core/Amazon.Runtime/ClientConfig.cs) to configure AWS clients to connect LocalStack. `ClientConfig` has two properties called `ServiceUrl` and `RegionEndpoint`, these are mutually exclusive properties. Whichever property is set last will cause the other to automatically be reset to null. LocalStack.NET has given priority to the RegionEndpoint property and the `us-east-1` region is used as the default value (Different regions can be set by using appsettings.json, see [RegionName](#session-regioname) entry. Because of it sets the RegionEndpoint property after the ServiceUrl property, ServiceUrl will be set to null.
+
+To override this behavior, the `useServiceUrl` optional parameter can be set to `true` as below.
+
+```csharp
+var sessionOptions = new SessionOptions();
+var configOptions = new ConfigOptions();
+
+ISession session = SessionStandalone.Init()
+                                .WithSessionOptions(sessionOptions)
+                                .WithConfigurationOptions(configOptions).Create();
+
+var amazonS3Client = session.CreateClientByImplementation<AmazonMediaStoreDataClient>(true);
+var amazonS3Client = session.CreateClientByImplementation<AmazonS3Client>();
+```
+
+The `RegionEndpoint` is not applicable for services such as AWS MediaStore, Iot. The optional parameter `useServiceUrl` can be useful for use in such scenarios.
+
+`CreateClientByInterface<TSerice>` method can also be used to create AWS service, as follows
+
+```csharp
+var amazonS3Client = session.CreateClientByInterface<IAmazonMediaStoreData>(true);
+```
+
 ### <a name="di"></a>  Microsoft.Extensions.DependencyInjection Initialization
 
 First, you need to install `Microsoft.Extensions.DependencyInjection` nuget package as follows
@@ -343,6 +394,8 @@ ServiceProvider serviceProvider = collection.BuildServiceProvider();
 var amazonS3Client = serviceProvider.GetRequiredService<IAmazonS3>();
 ```
 
+See [useServiceUrl] parameter usage (#standalone-useserviceurl)
+
 ## <a name="developing"></a> Developing
 
 We welcome feedback, bug reports, and pull requests!
@@ -387,6 +440,21 @@ Linux
 
 ## <a name="changelog"></a> Changelog
 
+### [v1.3.0](https://github.com/localstack-dotnet/localstack-dotnet-client/releases/tag/v1.3.0)
+
+#### 1. New Features
+- New endpoints in the official [Localstack Python Client](https://github.com/localstack/localstack-python-client) v1.27 have been added.
+  - SESv2
+  - EventBridge ([#14](https://github.com/localstack-dotnet/localstack-dotnet-client/pull/14))
+- Tested against LocalStack v0.13.0 container.
+#### 2. Enhancements
+- `useServiceUrl` parameter added to change client connection behavior. See [useServiceUrl Parameter](#useserviceurl)
+- Readme and SourceLink added to Nuget packages
+#### 3. Bug Fixes
+- Session::RegionName configuration does not honor while creating AWS client ([#15](https://github.com/localstack-dotnet/localstack-dotnet-client/issues/15))
+
+Thanks to [petertownsend](https://github.com/petertownsend) for his contribution
+
 ### [v1.2.3](https://github.com/localstack-dotnet/localstack-dotnet-client/releases/tag/v1.2.3)
 
 - New endpoints in the official [Localstack Python Client](https://github.com/localstack/localstack-python-client) v1.25 have been added.

build/LocalStack.Build/LocalStack.Build.csproj

@@ -7,6 +7,7 @@
 		<NoWarn>CA1303</NoWarn>
 	</PropertyGroup>
 	<ItemGroup>
+		<PackageReference Include="Cake.Docker" Version="1.0.0" />
 		<PackageReference Include="Cake.Frosting" Version="1.3.0" />
 	</ItemGroup>
 </Project>

build/LocalStack.Build/Program.cs

@@ -1,4 +1,6 @@
-return new CakeHost()
+using Cake.Docker;
+
+return new CakeHost()
        .UseContext<BuildContext>()
        .Run(args);
 
@@ -84,6 +86,29 @@ public override void Run(BuildContext context)
                 context.Warning($"=============Running {targetFramework.ToUpper()} tests for {testProj.AssemblyName}=============");
                 settings.Framework = targetFramework;
 
+                if (testProj.AssemblyName == "LocalStack.Client.Functional.Tests")
+                {
+                    context.Warning("Deleting running docker containers");
+
+                    try
+                    {
+                        string psOutput = context.DockerPs(new DockerContainerPsSettings() { All = true, Quiet = true});
+
+                        if (!string.IsNullOrEmpty(psOutput))
+                        {
+                            context.Warning(psOutput);
+
+                            string[] containers = psOutput.Split(new[]{ Environment.NewLine }, StringSplitOptions.None);
+                            context.DockerRm(containers);
+                        }
+                    }
+                    catch
+                    {
+                        // ignored
+                    }
+                }
+
+
                 if (context.IsRunningOnUnix() && targetFramework == "net461")
                 {
                     context.RunXUnitUsingMono(targetFramework, $"{testProj.DirectoryPath}/bin/{context.BuildConfiguration}/{targetFramework}/{testProj.AssemblyName}.dll");

src/Directory.Build.props

@@ -5,6 +5,6 @@
     <Owners>LocalStack.NET</Owners>
     <PackageProjectUrl>https://github.com/localstack-dotnet/localstack-dotnet-client</PackageProjectUrl>
     <PackageIcon>localstack-dotnet-square.png</PackageIcon>
-    <Version>1.2</Version>
+    <Version>1.3</Version>
   </PropertyGroup>
 </Project>

src/LocalStack.Client.Extensions/GlobalUsings.cs

@@ -1,11 +1,15 @@
 global using System;
 global using System.Reflection;
+
 global using Microsoft.Extensions.Configuration;
 global using Microsoft.Extensions.DependencyInjection;
 global using Microsoft.Extensions.DependencyInjection.Extensions;
 global using Microsoft.Extensions.Options;
+
+global using Amazon;
 global using Amazon.Extensions.NETCore.Setup;
 global using Amazon.Runtime;
+
 global using LocalStack.Client.Contracts;
 global using LocalStack.Client.Extensions.Contracts;
 global using LocalStack.Client.Options;

src/LocalStack.Client.Extensions/LocalStack.Client.Extensions.csproj

@@ -6,19 +6,27 @@
     <AssemblyName>LocalStack.Client.Extensions</AssemblyName>
     <RootNamespace>LocalStack.Client.Extensions</RootNamespace>
     <LangVersion>latest</LangVersion>
+    <Version>1.1.2</Version>
 
     <Title>LocalStack.NET Client</Title>
     <Description>
       Extensions for the LocalStack.NET Client to integrate with .NET Core configuration and dependency injection frameworks. The extensions also provides wrapper around AWSSDK.Extensions.NETCore.Setup to use both LocalStack and AWS side-by-side
     </Description>
     <PackageTags>aws-sdk, localstack, client-library, dotnet, dotnet-core</PackageTags>
     <PackageLicenseFile>LICENSE.txt</PackageLicenseFile>
-    <Version>1.1.0</Version>
+    <PackageReadmeFile>README.md</PackageReadmeFile>
+    <PublishRepositoryUrl>true</PublishRepositoryUrl>
+    <EmbedUntrackedSources>true</EmbedUntrackedSources>
+    <AllowedOutputExtensionsInPackageBuildOutputFolder>$(AllowedOutputExtensionsInPackageBuildOutputFolder);.pdb</AllowedOutputExtensionsInPackageBuildOutputFolder>
+  </PropertyGroup>
+
+  <PropertyGroup Condition="'$(GITHUB_ACTIONS)' == 'true'">
+    <ContinuousIntegrationBuild>true</ContinuousIntegrationBuild>
   </PropertyGroup>
 
   <ItemGroup>
     <PackageReference Include="AWSSDK.Extensions.NETCore.Setup" Version="3.7.1" />
-    <PackageReference Include="Microsoft.SourceLink.GitHub" Version="1.1.0" PrivateAssets="All" />
+    <PackageReference Include="Microsoft.SourceLink.GitHub" Version="1.1.1" PrivateAssets="All" />
 
     <PackageReference Include="Microsoft.Extensions.Configuration.Abstractions" Version="3.0.0" />
     <PackageReference Include="Microsoft.Extensions.Configuration.Binder" Version="3.0.0" />
@@ -27,50 +35,29 @@
     <PackageReference Include="Microsoft.Extensions.Options.ConfigurationExtensions" Version="3.0.0" />
   </ItemGroup>
 
-
-  
-  <!--<ItemGroup Condition="'$(TargetFramework)' == 'netstandard2.0'">
-    <PackageReference Include="Microsoft.Extensions.Configuration.Abstractions" Version="3.0.0" />
-    <PackageReference Include="Microsoft.Extensions.DependencyInjection.Abstractions" Version="3.0.0" />
-    <PackageReference Include="Microsoft.Extensions.Logging.Abstractions" Version="3.0.0" />
-    <PackageReference Include="Microsoft.Extensions.Options.ConfigurationExtensions" Version="3.0.0" />
-    <PackageReference Include="Microsoft.Extensions.Configuration.Binder" Version="3.0.0" />
-  </ItemGroup>
-
-  <ItemGroup Condition="'$(TargetFramework)' == 'net5.0'">
-    <PackageReference Include="Microsoft.Extensions.Configuration.Abstractions" Version="5.0.0" />
-    <PackageReference Include="Microsoft.Extensions.DependencyInjection.Abstractions" Version="5.0.0" />
-    <PackageReference Include="Microsoft.Extensions.Logging.Abstractions" Version="5.0.0" />
-    <PackageReference Include="Microsoft.Extensions.Options.ConfigurationExtensions" Version="5.0.0" />
-  </ItemGroup>
-
-  <ItemGroup Condition="'$(TargetFramework)' == 'net6.0'">
-    <PackageReference Include="Microsoft.Extensions.Configuration.Abstractions" Version="6.0.0" />
-    <PackageReference Include="Microsoft.Extensions.DependencyInjection.Abstractions" Version="6.0.0" />
-    <PackageReference Include="Microsoft.Extensions.Logging.Abstractions" Version="6.0.0" />
-    <PackageReference Include="Microsoft.Extensions.Options.ConfigurationExtensions" Version="6.0.0" />
-  </ItemGroup>-->
-
   <Target Name="PreBuild" AfterTargets="PreBuildEvent">
     <ItemGroup>
       <LicenseFile Include="../../LICENSE" />
     </ItemGroup>
+    <ItemGroup>
+      <ReadmeFile Include="../../README.md" />
+    </ItemGroup>
     <Copy SourceFiles="@(LicenseFile)" DestinationFiles="@(LicenseFile->'./LICENSE.txt')" SkipUnchangedFiles="true" />
+    <Copy SourceFiles="@(ReadmeFile)" DestinationFiles="@(ReadmeFile->'./README.md')" SkipUnchangedFiles="true" />
   </Target>
 
   <ItemGroup>
     <None Include="LICENSE.txt" Pack="true" PackagePath="">
       <CopyToOutputDirectory>Always</CopyToOutputDirectory>
     </None>
+    <None Include="README.md" Pack="true" PackagePath="">
+      <CopyToOutputDirectory>Always</CopyToOutputDirectory>
+    </None>
     <None Include="../../assets/localstack-dotnet-square.png" Pack="true" PackagePath="" />
   </ItemGroup>
 
   <ItemGroup>
     <ProjectReference Include="..\LocalStack.Client\LocalStack.Client.csproj" />
   </ItemGroup>
 
-  <ItemGroup>
-    <Folder Include="Contracts\" />
-  </ItemGroup>
-
 </Project>