Merge pull request #275 from DFE-Digital/feature/reference-nuget-regi…

…stry

added a ref to the nuget registry

.github/workflows/build-and-push-image.yml

@@ -67,6 +67,7 @@ jobs:
           context: .
           file: Dockerfile
           build-args: COMMIT_SHA=${{ needs.set-env.outputs.checked-out-sha }}
+          secrets: github_token=${{ secrets.GITHUB_TOKEN }}
           tags: |
             ${{ secrets.AZURE_ACR_URL }}/${{ env.DOCKER_IMAGE }}:${{ needs.set-env.outputs.branch }}
             ${{ secrets.AZURE_ACR_URL }}/${{ env.DOCKER_IMAGE }}:${{ needs.set-env.outputs.release }}

.github/workflows/continuous-integration-image-build-test.yml

@@ -19,4 +19,4 @@ jobs:
         run: |
           cp .env.development.local.example .env.development.local
           cp .env.database.example .env.database
-          docker-compose -f docker-compose.yml -p app build
+          docker-compose -f docker-compose.yml -p app build --secrets github_token: ${{ secrets.GITHUB_TOKEN }}

.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+    "dotnet.defaultSolution": "Dfe.Academies.Academisation.sln"
+}

Dfe.Academies.Academisation.Service.UnitTest/Extensions/StringExtensionsTests.cs

@@ -0,0 +1,31 @@
+namespace Dfe.Academies.Academisation.Service.UnitTest.Extensions;
+using Dfe.Academies.Academisation.Service.Extensions;
+using Xunit;
+
+/// <summary>
+/// The string extensions tests.
+/// </summary>
+public class StringExtensionsTests
+{
+	/// <summary>
+	/// The to title case tests.
+	/// </summary>
+	public class ToTitleCaseTests
+	{
+		/// <summary>
+		/// Givens the string_ should convert to title case.
+		/// </summary>
+		/// <param name="givenString">The given string.</param>
+		/// <param name="expectedStringAsTitleCase">The expected string as title case.</param>
+		[Theory]
+		[InlineData(null, null)]
+		[InlineData("", "")]
+		[InlineData("All Title Case", "All Title Case")]
+		[InlineData("all lower case", "All Lower Case")]
+		public void GivenString_ShouldConvertToTitleCase(string givenString, string expectedStringAsTitleCase)
+		{
+			string? result = givenString?.ToTitleCase();
+			Assert.Equal(expectedStringAsTitleCase, result);
+		}
+	}
+}

Dfe.Academies.Academisation.Service/Dfe.Academies.Academisation.Service.csproj

@@ -22,6 +22,7 @@
   <ItemGroup>
     <PackageReference Include="Ardalis.GuardClauses" Version="4.0.1" />
     <PackageReference Include="AutoMapper" Version="12.0.1" />
+    <PackageReference Include="Dfe.Academisation.ExtensionMethods" Version="1.2.0" />
     <PackageReference Include="MediatR" Version="12.0.1" />
   </ItemGroup>
 

Dfe.Academies.Academisation.Service/Extensions/StringExtensions.cs

@@ -0,0 +1,18 @@
+namespace Dfe.Academies.Academisation.Service.Extensions;
+using Dfe.Academisation.ExtensionMethods;
+
+/// <summary>
+/// The string extensions.
+/// </summary>
+internal static class StringExtensions
+{
+	/// <summary>
+	/// Title cases a string. Not used, just added to test nuget reference.
+	/// </summary>
+	/// <param name="string">The string.</param>
+	/// <returns>A string.</returns>
+	public static string ToTitleCase(this string @string)
+	{
+		return Dfe.Academisation.ExtensionMethods.StringExtensions.ToTitleCase(@string);
+	}
+}

Dockerfile

@@ -16,6 +16,7 @@ COPY ./Dfe.Academies.Academisation.Service/ ./Dfe.Academies.Academisation.Servic
 COPY ./Dfe.Academies.Academisation.WebApi/ ./Dfe.Academies.Academisation.WebApi/
 COPY ./Dfe.Academies.Academisation.sln/ ./Dfe.Academies.Academisation.sln
 
+RUN --mount=type=secret,id=github_token dotnet nuget add source --username USERNAME --password $(cat /run/secrets/github_token) --store-password-in-clear-text --name github "https://nuget.pkg.github.com/DFE-Digital/index.json"
 RUN dotnet restore Dfe.Academies.Academisation.WebApi
 RUN dotnet build Dfe.Academies.Academisation.WebApi
 

docker-compose.yml

@@ -3,6 +3,8 @@ services:
   webapi:
     build:
       context: .
+      secrets:
+        - github_token
     command: /bin/bash -c "./docker-entrypoint.sh dotnet Dfe.Academies.Academisation.WebApi.dll"
     ports:
       - 80:80/tcp