Test package fix

Signed-off-by: Bill DeRusha <[email protected]>
Green-Software-Foundation · Sep 11, 2023 · 408fcb1 · 408fcb1
1 parent 1f1cc05
commit 408fcb1
Show file tree

Hide file tree

Showing 29 changed files with 167 additions and 39 deletions.
diff --git a/.github/workflows/1-pr.yaml b/.github/workflows/1-pr.yaml
@@ -11,7 +11,7 @@ env:
   DLL_FILE_PATH: "./bin/Release/net6.0/CarbonAware.WebApi.dll"
   DOTNET_SRC_DIR: "./src"
   # console app packages
-  DOTNET_SOLUTION: "src/GSF.CarbonAware/src/GSF.CarbonAware.csproj"
+  DOTNET_SOLUTION: "src/CarbonAwareSDK.sln"
   OUTPUT_DIR: "packages"
   CONSOLE_APP: "samples/lib-integration/ConsoleApp/ConsoleApp.csproj"
   CREATE_PKGS: "scripts/package/create_packages.ps1"

diff --git a/.github/workflows/verify-azure-function-with-packages.yaml b/.github/workflows/verify-azure-function-with-packages.yaml
@@ -29,23 +29,28 @@ jobs:
       - name: Docker Target Final
         run: |
           docker build --no-cache . -f ${{ env.DOCKERFILE_PATH }} -t ${{ env.CONTAINER_IMAGE_NAME }}
-          docker rmi -f $(docker images -f "dangling=true" -q)
+          docker image prune -f
 
       - name: Docker Run Container
-        run: docker run -d --name ${{ env.CONTAINER_RUNTIME_NAME }} -p 8080:80 ${{ env.CONTAINER_IMAGE_NAME }}
+        run: |
+          docker run -d --name ${{ env.CONTAINER_RUNTIME_NAME }} -p 8080:80 ${{ env.CONTAINER_IMAGE_NAME }}
+          timeout 30 bash -c -- 'while [ -z "$(docker ps -q)" ]; do echo "waiting for container to start" && sleep 5s; done'
+          docker ps
 
       # Request fails with authentication error. Expected
       - name: Get Average Carbon Intensity
         run: |
           set +e
-          ret_code=$(wget -S -t 5 --waitretry=5 "http://0.0.0.0:8080/api/GetAverageCarbonIntensity?startDate=2022-03-01T15:30:00Z&endDate=2022-03-01T18:30:00Z&location=eastus" 2>&1 | grep "HTTP/" | awk '{print $2}')
+          ret_code=$(wget --server-response "http://0.0.0.0:8080/api/GetAverageCarbonIntensity?startDate=2022-03-01T15:30:00Z&endDate=2022-03-01T18:30:00Z&location=eastus" 2>&1 | awk '/^  HTTP/{print $2}')
+          echo "Return Code: $ret_code"
           set -e
-          [ "401" == $ret_code ]
+          [ "401" = "$ret_code" ] 
 
       # Request fails with authentication error. Expected
       - name: Get Current Forecast
         run: |
           set +e
-          ret_code=$(wget -S -t 5 --waitretry=5 "http://0.0.0.0:8080/api/GetCurrentForecast" --header "Content-Type: application/json" --post-data '{"startDate":"2022-11-02T15:30:00Z","endDate":"2022-11-02T18:30:00Z","location":"eastus","duration":"15"}' 2>&1 | grep "HTTP/" | awk '{print $2}')
+          ret_code=$(wget --server-response "http://0.0.0.0:8080/api/GetCurrentForecast" --header "Content-Type: application/json" --post-data '{"startDate":"2022-11-02T15:30:00Z","endDate":"2022-11-02T18:30:00Z","location":"eastus","duration":"15"}' 2>&1 | awk '/^  HTTP/{print $2}')
+          echo "Return Code: $ret_code"
           set -e
-          [ "401" == $ret_code ]
+          [ "401" = "$ret_code" ] 
diff --git a/.gitignore b/.gitignore
@@ -33,3 +33,6 @@ src/data/location-sources/custom-azure-zones.json
 
 # exclude artifacts on java-client example
 samples/java-client/target
+
+# exclude artifacts from default package builder
+/packages
diff --git a/docs/packaging.md b/docs/packaging.md
@@ -18,21 +18,21 @@ showing how the package can be consumed.
   - [Console App Sample](#console-app-sample)
     - [Run the Sample Console App](#run-the-sample-console-app)
 
-## Included Projects
+## Included Packages
 
-The current package include 7 projects from the SDK:
+The current solution creates 5 packages from the SDK projects:
 
 1. "GSF.CarbonAware"
-2. "CarbonAware"
-3. "CarbonAware.DataSources.ElectricityMapsFree"
-4. "CarbonAware.DataSources.ElectricityMaps"
-5. "CarbonAware.DataSources.Json"
-6. "CarbonAware.DataSources.WattTime"
-7. "CarbonAware.LocationSources"
-
-These 7 projects enable users of the library to consume the current endpoints
-exposed by the library. The package that needs to be added to a new C# project
-is `GSF.CarbonAware`.
+  1. "CarbonAware"
+  2. "CarbonAware.LocationSources"
+2. "CarbonAware.DataSources.ElectricityMapsFree"
+3. "CarbonAware.DataSources.ElectricityMaps"
+4. "CarbonAware.DataSources.Json"
+5. "CarbonAware.DataSources.WattTime"
+
+Adding the `GSF.CarbonAware` project to your C# projects gives you access to all
+CarbonAware SDK interfaces.
+Additionally, operators must add any data source packages they plan to use.
 
 ## Included Scripts
 

diff --git a/samples/azure/azure-function/Dockerfile b/samples/azure/azure-function/Dockerfile
@@ -10,7 +10,9 @@ COPY ["scripts/", "data/scripts/"]
 COPY ["samples/", "data/samples/"]
 
 WORKDIR /data
-RUN pwsh -c scripts/package/create_packages.ps1 src/GSF.CarbonAware/src/GSF.CarbonAware.csproj /packages && \
+RUN pwsh -c scripts/package/create_packages.ps1 src/CarbonAwareSDK.sln /packages && \
+    dotnet nuget locals all --clear && \
+    dotnet nuget add source /packages -n carbonaware && \
     dotnet restore "samples/azure/azure-function/function.csproj" && \
     pwsh -c scripts/package/add_packages.ps1 samples/azure/azure-function/function.csproj /packages && \
     dotnet build "samples/azure/azure-function/function.csproj" -c Release -o /app/build
@@ -20,4 +22,6 @@ RUN dotnet publish "samples/azure/azure-function/function.csproj" -c Release -o
 
 FROM base AS final
 WORKDIR /home/site/wwwroot
+ENV AzureWebJobsScriptRoot=/home/site/wwwroot \
+    AzureFunctionsJobHost__Logging__Console__IsEnabled=true
 COPY --from=publish /app/publish .
diff --git a/samples/azure/azure-function/function.csproj b/samples/azure/azure-function/function.csproj
@@ -4,6 +4,9 @@
     <AzureFunctionsVersion>v4</AzureFunctionsVersion>
   </PropertyGroup>
   <ItemGroup>
+    <PackageReference Include="CarbonAware.DataSources.Json" Version="1.0.0" />
+    <PackageReference Include="CarbonAware.DataSources.WattTime" Version="1.0.0" />
+    <PackageReference Include="GSF.CarbonAware" Version="1.0.0-beta" />
     <PackageReference Include="Microsoft.AspNetCore.Http.Abstractions" Version="2.2.0" />
     <PackageReference Include="Microsoft.Extensions.Configuration" Version="6.0.1" />
     <PackageReference Include="Microsoft.Extensions.DependencyInjection" Version="6.0.0" />

diff --git a/samples/azure/azure-function/host.json b/samples/azure/azure-function/host.json
@@ -6,6 +6,10 @@
                 "isEnabled": true,
                 "excludedTypes": "Request"
             }
+        }, 
+        "logLevel": {
+            "default": "Information"
         }
-    }
+    },
+    "tracing": {"consoleLevel": "verbose"}
 }
diff --git a/scripts/package/add_packages.ps1 b/scripts/package/add_packages.ps1
@@ -13,6 +13,10 @@ if ([string]::IsNullOrEmpty($DOTNET_PROJECT) -or [string]::IsNullOrEmpty($PACKAG
 
 $packages = @(
     "GSF.CarbonAware"
+    "CarbonAware.DataSources.Json"
+    "CarbonAware.DataSources.WattTime"
+    "CarbonAware.DataSources.ElectricityMaps"
+    "CarbonAware.DataSources.ElectricityMapsFree"
 )
 
 # Remove packages from project
@@ -21,6 +25,7 @@ foreach ($pname in $packages) {
 }
 
 Remove-Item -Recurse -Force ~/.nuget/packages/gsf.carbonaware*
+Remove-Item -Recurse -Force ~/.nuget/packages/carbonaware.datasources*
 
 # Add packages to project
 foreach ($pname in $packages) {

diff --git a/scripts/package/create_packages.ps1 b/scripts/package/create_packages.ps1
@@ -14,7 +14,7 @@ if ([string]::IsNullOrEmpty($DOTNET_SOLUTION) -or [string]::IsNullOrEmpty($DEST_
 $REVISION = $(git rev-parse HEAD)
 $BRANCH = "dev"
 
-New-Item -Path $DEST_PACKAGES -ItemType Directory
+New-Item -Path $DEST_PACKAGES -ItemType Directory -Force | Out-Null
 
 # Remove existing packages
 Get-ChildItem -Path $path -Recurse -Include *.nupkg, *.snupkg | Remove-Item

diff --git a/src/CarbonAware.CLI/src/CarbonAware.CLI.csproj b/src/CarbonAware.CLI/src/CarbonAware.CLI.csproj
@@ -27,6 +27,14 @@
     <ProjectReference Include="..\..\CarbonAware\src\CarbonAware.csproj" />
     <ProjectReference Include="..\..\CarbonAware.LocationSources\src\CarbonAware.LocationSources.csproj" />
     <ProjectReference Include="..\..\GSF.CarbonAware\src\GSF.CarbonAware.csproj" />
+    <ProjectReference
+      Include="..\..\CarbonAware.DataSources\CarbonAware.DataSources.Json\src\CarbonAware.DataSources.Json.csproj" />
+    <ProjectReference
+      Include="..\..\CarbonAware.DataSources\CarbonAware.DataSources.WattTime\src\CarbonAware.DataSources.WattTime.csproj" />
+    <ProjectReference
+      Include="..\..\CarbonAware.DataSources\CarbonAware.DataSources.ElectricityMaps\src\CarbonAware.DataSources.ElectricityMaps.csproj" />
+    <ProjectReference
+      Include="..\..\CarbonAware.DataSources\CarbonAware.DataSources.ElectricityMapsFree\src\CarbonAware.DataSources.ElectricityMapsFree.csproj" />
   </ItemGroup>
 
   <ItemGroup>

diff --git a/...are.DataSources.ElectricityMaps/mock/CarbonAware.DataSources.ElectricityMaps.Mocks.csproj b/...are.DataSources.ElectricityMaps/mock/CarbonAware.DataSources.ElectricityMaps.Mocks.csproj
@@ -13,6 +13,7 @@
 
   <ItemGroup>
     <ProjectReference Include="..\src\CarbonAware.DataSources.ElectricityMaps.csproj" />
+    <ProjectReference Include="..\..\..\CarbonAware\src\CarbonAware.csproj" />
   </ItemGroup>
 
   <ItemGroup>

diff --git a/...arbonAware.DataSources.ElectricityMaps/src/CarbonAware.DataSources.ElectricityMaps.csproj b/...arbonAware.DataSources.ElectricityMaps/src/CarbonAware.DataSources.ElectricityMaps.csproj
@@ -14,10 +14,21 @@
   </ItemGroup>
 
   <ItemGroup>
-    <ProjectReference Include="..\..\..\CarbonAware\src\CarbonAware.csproj" />
+    <PackageReference Include="Microsoft.Extensions.Http" Version="6.0.0" />
   </ItemGroup>
 
-  <ItemGroup>
-    <PackageReference Include="Microsoft.Extensions.Http" Version="6.0.0" />
+    <ItemGroup>
+    <ProjectReference Include="..\..\..\CarbonAware\src\CarbonAware.csproj" PrivateAssets="all" />
+  </ItemGroup>
+
+  <!-- Add files required to create a package -->
+  <ItemGroup Label="FilesToCopy">
+    <Content Include="$(AssemblyName).targets" Pack="true"
+      PackagePath="build/$(AssemblyName).targets" />
+    <Content Include="$(TargetDir)/CarbonAware.dll" Pack="true" PackagePath="lib/net6.0/" />
+  </ItemGroup>
+
+  <ItemGroup Label="IncludeSymbols" Condition="$(IncludeSymbols) == true">
+    <Content Include="$(TargetDir)/CarbonAware.pdb" Pack="true" PackagePath="lib/net6.0/" />
   </ItemGroup>
 </Project>
diff --git a/...rbonAware.DataSources.ElectricityMaps/src/CarbonAware.DataSources.ElectricityMaps.targets b/...rbonAware.DataSources.ElectricityMaps/src/CarbonAware.DataSources.ElectricityMaps.targets
@@ -0,0 +1,8 @@
+<Project>
+    <ItemGroup>
+        <DllFiles Include="$(MSBuildThisFileDirectory)/../lib/net6.0/*.dll" />
+    </ItemGroup>
+    <Target Name="CopyDllFiles" BeforeTargets="BeforeBuild">
+        <Copy SourceFiles="@(DllFiles)" DestinationFolder="$(TargetDir)" />
+    </Target>
+</Project>
diff --git a/...are.DataSources.ElectricityMaps/test/CarbonAware.DataSources.ElectricityMaps.Tests.csproj b/...are.DataSources.ElectricityMaps/test/CarbonAware.DataSources.ElectricityMaps.Tests.csproj
@@ -27,6 +27,7 @@
 
   <ItemGroup>
     <ProjectReference Include="..\src\CarbonAware.DataSources.ElectricityMaps.csproj" />
+    <ProjectReference Include="..\..\..\CarbonAware\src\CarbonAware.csproj" />
   </ItemGroup>
 
 </Project>
diff --git a/...Sources.ElectricityMapsFree/mock/CarbonAware.DataSources.ElectricityMapsFree.Mocks.csproj b/...Sources.ElectricityMapsFree/mock/CarbonAware.DataSources.ElectricityMapsFree.Mocks.csproj
@@ -12,6 +12,7 @@
 
   <ItemGroup>
     <ProjectReference Include="..\src\CarbonAware.DataSources.ElectricityMapsFree.csproj" />
+    <ProjectReference Include="..\..\..\CarbonAware\src\CarbonAware.csproj" />
   </ItemGroup>
 
   <ItemGroup>

diff --git a/...re.DataSources.ElectricityMapsFree/src/CarbonAware.DataSources.ElectricityMapsFree.csproj b/...re.DataSources.ElectricityMapsFree/src/CarbonAware.DataSources.ElectricityMapsFree.csproj
@@ -12,7 +12,7 @@
   </ItemGroup>
 
   <ItemGroup>
-    <ProjectReference Include="..\..\..\CarbonAware\src\CarbonAware.csproj" />
+    <Folder Include="Constants\" />
   </ItemGroup>
 
   <ItemGroup>
@@ -21,7 +21,18 @@
   </ItemGroup>
 
   <ItemGroup>
-    <Folder Include="Constants\" />
+    <ProjectReference Include="..\..\..\CarbonAware\src\CarbonAware.csproj" PrivateAssets="all" />
+  </ItemGroup>
+
+  <!-- Add files required to create a package -->
+  <ItemGroup Label="FilesToCopy">
+    <Content Include="$(AssemblyName).targets" Pack="true"
+      PackagePath="build/$(AssemblyName).targets" />
+    <Content Include="$(TargetDir)/CarbonAware.dll" Pack="true" PackagePath="lib/net6.0/" />
+  </ItemGroup>
+
+  <ItemGroup Label="IncludeSymbols" Condition="$(IncludeSymbols) == true">
+    <Content Include="$(TargetDir)/CarbonAware.pdb" Pack="true" PackagePath="lib/net6.0/" />
   </ItemGroup>
 
 

diff --git a/...e.DataSources.ElectricityMapsFree/src/CarbonAware.DataSources.ElectricityMapsFree.targets b/...e.DataSources.ElectricityMapsFree/src/CarbonAware.DataSources.ElectricityMapsFree.targets
@@ -0,0 +1,8 @@
+<Project>
+    <ItemGroup>
+        <DllFiles Include="$(MSBuildThisFileDirectory)/../lib/net6.0/*.dll" />
+    </ItemGroup>
+    <Target Name="CopyDllFiles" BeforeTargets="BeforeBuild">
+        <Copy SourceFiles="@(DllFiles)" DestinationFolder="$(TargetDir)" />
+    </Target>
+</Project>
diff --git a/...Sources.ElectricityMapsFree/test/CarbonAware.DataSources.ElectricityMapsFree.Tests.csproj b/...Sources.ElectricityMapsFree/test/CarbonAware.DataSources.ElectricityMapsFree.Tests.csproj
@@ -19,6 +19,7 @@
   <ItemGroup>
     <ProjectReference Include="..\..\..\CarbonAware.LocationSources\src\CarbonAware.LocationSources.csproj" />
     <ProjectReference Include="..\src\CarbonAware.DataSources.ElectricityMapsFree.csproj" />
+    <ProjectReference Include="..\..\..\CarbonAware\src\CarbonAware.csproj" />
   </ItemGroup>
 
 </Project>
diff --git a/...e.DataSources/CarbonAware.DataSources.Json/mock/CarbonAware.DataSources.Json.Mocks.csproj b/...e.DataSources/CarbonAware.DataSources.Json/mock/CarbonAware.DataSources.Json.Mocks.csproj
@@ -9,6 +9,7 @@
 
   <ItemGroup>
     <ProjectReference Include="..\src\CarbonAware.DataSources.Json.csproj" />
+    <ProjectReference Include="..\..\..\CarbonAware\src\CarbonAware.csproj" />
   </ItemGroup>
 
   <ItemGroup>

diff --git a/...bonAware.DataSources/CarbonAware.DataSources.Json/src/CarbonAware.DataSources.Json.csproj b/...bonAware.DataSources/CarbonAware.DataSources.Json/src/CarbonAware.DataSources.Json.csproj
@@ -4,7 +4,6 @@
     <ImplicitUsings>enable</ImplicitUsings>
     <Nullable>enable</Nullable>
     <EnforceCodeStyleInBuild>true</EnforceCodeStyleInBuild>
-    <IsPackable>false</IsPackable>
   </PropertyGroup>
 
   <ItemGroup>
@@ -21,6 +20,18 @@
   </ItemGroup>
 
   <ItemGroup>
-    <ProjectReference Include="..\..\..\CarbonAware\src\CarbonAware.csproj" />
+    <ProjectReference Include="..\..\..\CarbonAware\src\CarbonAware.csproj" PrivateAssets="all" />
+  </ItemGroup>
+
+  <!-- Add files required to create a package -->
+  <ItemGroup Label="FilesToCopy">
+    <Content Include="$(AssemblyName).targets" Pack="true"
+      PackagePath="build/$(AssemblyName).targets" />
+    <Content Include="$(TargetDir)/CarbonAware.dll" Pack="true" PackagePath="lib/net6.0/" />
+    <Content Include="$(TargetDir)/data-sources/**/*.json" Pack="true" PackagePath="data-sources/" />
+  </ItemGroup>
+
+  <ItemGroup Label="IncludeSymbols" Condition="$(IncludeSymbols) == true">
+    <Content Include="$(TargetDir)/CarbonAware.pdb" Pack="true" PackagePath="lib/net6.0/" />
   </ItemGroup>
 </Project>
diff --git a/...onAware.DataSources/CarbonAware.DataSources.Json/src/CarbonAware.DataSources.Json.targets b/...onAware.DataSources/CarbonAware.DataSources.Json/src/CarbonAware.DataSources.Json.targets
@@ -0,0 +1,16 @@
+<Project>
+    <ItemGroup> 
+        <DataSourceFiles Include="$(MSBuildThisFileDirectory)/../data-sources/**/*.*" />
+    </ItemGroup>
+    <Target Name="CopyDataSourceFiles" BeforeTargets="BeforeBuild">
+        <Copy SourceFiles="@(DataSourceFiles)" DestinationFolder="$(TargetDir)/data-sources/%(RecursiveDir)" />
+        <!-- Copy to bin dir for Azure Functions to work -->
+        <Copy SourceFiles="@(DataSourceFiles)" DestinationFolder="$(TargetDir)/bin/data-sources/%(RecursiveDir)" />
+    </Target>
+    <ItemGroup>
+        <DllFiles Include="$(MSBuildThisFileDirectory)/../lib/net6.0/*.dll" />
+    </ItemGroup>
+    <Target Name="CopyDllFiles" BeforeTargets="BeforeBuild">
+        <Copy SourceFiles="@(DllFiles)" DestinationFolder="$(TargetDir)" />
+    </Target>
+</Project>
diff --git a/...e.DataSources/CarbonAware.DataSources.Json/test/CarbonAware.DataSources.Json.Tests.csproj b/...e.DataSources/CarbonAware.DataSources.Json/test/CarbonAware.DataSources.Json.Tests.csproj
@@ -24,6 +24,7 @@
 
   <ItemGroup>
     <ProjectReference Include="..\src\CarbonAware.DataSources.Json.csproj" />
+    <ProjectReference Include="..\..\..\CarbonAware\src\CarbonAware.csproj" />
   </ItemGroup>
 
 </Project>
diff --git a/...urces/CarbonAware.DataSources.WattTime/mock/CarbonAware.DataSources.WattTime.Mocks.csproj b/...urces/CarbonAware.DataSources.WattTime/mock/CarbonAware.DataSources.WattTime.Mocks.csproj
@@ -13,6 +13,7 @@
 
   <ItemGroup>
     <ProjectReference Include="..\src\CarbonAware.DataSources.WattTime.csproj" />
+    <ProjectReference Include="..\..\..\CarbonAware\src\CarbonAware.csproj" />
   </ItemGroup>
 
   <ItemGroup>

diff --git a/....DataSources/CarbonAware.DataSources.WattTime/src/CarbonAware.DataSources.WattTime.csproj b/....DataSources/CarbonAware.DataSources.WattTime/src/CarbonAware.DataSources.WattTime.csproj
@@ -5,7 +5,6 @@
     <ImplicitUsings>enable</ImplicitUsings>
     <Nullable>enable</Nullable>
     <EnforceCodeStyleInBuild>true</EnforceCodeStyleInBuild>
-    <IsPackable>false</IsPackable>
   </PropertyGroup>
 
   <ItemGroup>
@@ -25,7 +24,18 @@
   </ItemGroup>
 
   <ItemGroup>
-    <ProjectReference Include="..\..\..\CarbonAware\src\CarbonAware.csproj" />
+    <ProjectReference Include="..\..\..\CarbonAware\src\CarbonAware.csproj" PrivateAssets="all" />
+  </ItemGroup>
+
+  <!-- Add files required to create a package -->
+  <ItemGroup Label="FilesToCopy">
+    <Content Include="$(AssemblyName).targets" Pack="true"
+      PackagePath="build/$(AssemblyName).targets" />
+    <Content Include="$(TargetDir)/CarbonAware.dll" Pack="true" PackagePath="lib/net6.0/" />
+  </ItemGroup>
+
+  <ItemGroup Label="IncludeSymbols" Condition="$(IncludeSymbols) == true">
+    <Content Include="$(TargetDir)/CarbonAware.pdb" Pack="true" PackagePath="lib/net6.0/" />
   </ItemGroup>
 
 </Project>
diff --git a/...DataSources/CarbonAware.DataSources.WattTime/src/CarbonAware.DataSources.WattTime.targets b/...DataSources/CarbonAware.DataSources.WattTime/src/CarbonAware.DataSources.WattTime.targets
@@ -0,0 +1,8 @@
+<Project>
+    <ItemGroup>
+        <DllFiles Include="$(MSBuildThisFileDirectory)/../lib/net6.0/*.dll" />
+    </ItemGroup>
+    <Target Name="CopyDllFiles" BeforeTargets="BeforeBuild">
+        <Copy SourceFiles="@(DllFiles)" DestinationFolder="$(TargetDir)" />
+    </Target>
+</Project>
diff --git a/...urces/CarbonAware.DataSources.WattTime/test/CarbonAware.DataSources.WattTime.Tests.csproj b/...urces/CarbonAware.DataSources.WattTime/test/CarbonAware.DataSources.WattTime.Tests.csproj
@@ -25,6 +25,7 @@
 
   <ItemGroup>
     <ProjectReference Include="..\src\CarbonAware.DataSources.WattTime.csproj" />
+    <ProjectReference Include="..\..\..\CarbonAware\src\CarbonAware.csproj" />
   </ItemGroup>
 
 </Project>