mirror of
https://github.com/logos-storage/logos-storage-nim-cs-dist-tests.git
synced 2026-07-11 17:50:10 +00:00
f496393ee6
The openapi.yaml driving NSwag client generation is no longer committed. A build-time target in LogosStorageClient.csproj extracts it byte-for-byte from the Logos Storage image (STORAGEDOCKERIMAGE, default latest-dist-tests) via 'docker cp' whenever a Docker daemon is reachable, always overwriting so the generated client matches the container under test. Where no daemon is reachable (the CI runner pod) the spec must be pre-placed on disk by the job's initContainer, else the build fails loudly. Because StoragePlugin's PreBuildEvent runs before project references are built, the old hash-injection prebuild read the spec before it could be materialized and baked a stale hash. Materialization and the ApiChecker hash check are therefore mutually exclusive, so ApiChecker and the LogosStoragePluginPrebuild project are removed here. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> # Conflicts: # ProjectPlugins/LogosStorageClient/openapi.yaml # ProjectPlugins/StoragePlugin/ApiChecker.cs # Conflicts: # ProjectPlugins/LogosStorageClient/openapi.yaml # ProjectPlugins/StoragePlugin/ApiChecker.cs
84 lines
4.9 KiB
XML
84 lines
4.9 KiB
XML
<Project Sdk="Microsoft.NET.Sdk">
|
|
|
|
<PropertyGroup>
|
|
<TargetFramework>net10.0</TargetFramework>
|
|
<ImplicitUsings>enable</ImplicitUsings>
|
|
<Nullable>enable</Nullable>
|
|
</PropertyGroup>
|
|
|
|
<ItemGroup>
|
|
<None Remove="openapi.yaml" />
|
|
</ItemGroup>
|
|
|
|
<ItemGroup>
|
|
<OpenApiReference Include="openapi.yaml" CodeGenerator="NSwagCSharp" Namespace="StorageOpenApi" ClassName="StorageApiClient" />
|
|
</ItemGroup>
|
|
|
|
<!--
|
|
openapi.yaml is NOT committed. This target materializes it before NSwag reads it, so the
|
|
generated API client is always in sync with the container under test.
|
|
|
|
Wherever a Docker daemon is reachable (Docker Desktop on Mac/Windows, Docker Engine on
|
|
Linux, WSL) the spec is extracted (and always overwritten) byte-for-byte from the Logos
|
|
Storage image via 'docker cp' - no running process, so the image startup banner is never
|
|
emitted, and no shell redirection, so it is portable across platforms. The leading
|
|
'docker rm -f' clears any container left behind by an interrupted build.
|
|
|
|
Where no daemon is reachable (the CI runner pod has none) the spec must already be on disk,
|
|
pre-placed from that same image by the job's initContainer; otherwise the build fails loudly
|
|
rather than generate a client against an unknown spec.
|
|
|
|
Image selection mirrors ProjectPlugins/StoragePlugin/DockerImage.cs.
|
|
-->
|
|
<Target Name="MaterializeOpenApi" BeforeTargets="_GenerateOpenApiCode">
|
|
<PropertyGroup>
|
|
<StorageDockerImage Condition="'$(STORAGEDOCKERIMAGE)' != ''">$(STORAGEDOCKERIMAGE)</StorageDockerImage>
|
|
<StorageDockerImage Condition="'$(STORAGEDOCKERIMAGE)' == ''">logosstorage/logos-storage-nim:latest-dist-tests</StorageDockerImage>
|
|
<OpenApiPath>$(MSBuildThisFileDirectory)openapi.yaml</OpenApiPath>
|
|
<OpenApiExtractContainer>logos-storage-openapi-extract</OpenApiExtractContainer>
|
|
</PropertyGroup>
|
|
|
|
<!-- 'docker info' succeeds only when a daemon is reachable: true on developer machines
|
|
(Docker Desktop or Linux Docker Engine), false (or no docker CLI) in the CI runner pod. -->
|
|
<Exec Command="docker info" ContinueOnError="true" StandardOutputImportance="low" StandardErrorImportance="low">
|
|
<Output TaskParameter="ExitCode" PropertyName="DockerInfoExitCode" />
|
|
</Exec>
|
|
|
|
<!-- No daemon: require the spec to have been pre-placed by the initContainer. -->
|
|
<Error Condition="'$(DockerInfoExitCode)' != '0' AND !Exists('$(OpenApiPath)')" Text="No Docker daemon reachable and '$(OpenApiPath)' is missing. In CI it must be pre-placed from the Logos Storage image by the job's initContainer. Locally, start Docker (Desktop or Engine) so the spec can be extracted automatically." />
|
|
<Message Condition="'$(DockerInfoExitCode)' != '0'" Importance="high" Text="No Docker daemon reachable. Using existing '$(OpenApiPath)'." />
|
|
|
|
<!-- Daemon reachable: extract (always overwrite) byte-for-byte from the image. -->
|
|
<Message Condition="'$(DockerInfoExitCode)' == '0'" Importance="high" Text="Docker daemon detected. Materializing openapi.yaml from image '$(StorageDockerImage)'..." />
|
|
<Exec Condition="'$(DockerInfoExitCode)' == '0'" Command="docker rm -f $(OpenApiExtractContainer)" ContinueOnError="true" StandardOutputImportance="low" StandardErrorImportance="low" />
|
|
<Exec Condition="'$(DockerInfoExitCode)' == '0'" Command="docker create --name $(OpenApiExtractContainer) $(StorageDockerImage)" StandardOutputImportance="low" />
|
|
<Exec Condition="'$(DockerInfoExitCode)' == '0'" Command="docker cp $(OpenApiExtractContainer):/logosstorage/openapi.yaml "$(OpenApiPath)"" />
|
|
<Exec Condition="'$(DockerInfoExitCode)' == '0'" Command="docker rm -f $(OpenApiExtractContainer)" StandardOutputImportance="low" />
|
|
|
|
<!-- Force NSwag to regenerate the client from the just-materialized spec. Without this, an
|
|
incremental build keeps a client generated from a previously materialized spec (e.g.
|
|
after switching STORAGEDOCKERIMAGE or pulling an updated image), producing a client that
|
|
no longer matches the container under test. -->
|
|
<Delete Files="$(MSBuildProjectDirectory)/obj/openapiClient.cs" />
|
|
</Target>
|
|
|
|
<ItemGroup>
|
|
<PackageReference Include="Microsoft.Extensions.ApiDescription.Client" Version="7.0.2">
|
|
<PrivateAssets>all</PrivateAssets>
|
|
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
|
|
</PackageReference>
|
|
<PackageReference Include="Newtonsoft.Json" Version="13.0.3" />
|
|
<PackageReference Include="NSwag.ApiDescription.Client" Version="13.18.2">
|
|
<PrivateAssets>all</PrivateAssets>
|
|
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
|
|
</PackageReference>
|
|
</ItemGroup>
|
|
|
|
<ItemGroup>
|
|
<ProjectReference Include="..\..\Framework\FileUtils\FileUtils.csproj" />
|
|
<ProjectReference Include="..\..\Framework\Logging\Logging.csproj" />
|
|
<ProjectReference Include="..\..\Framework\WebUtils\WebUtils.csproj" />
|
|
</ItemGroup>
|
|
|
|
</Project>
|