Added first version of Ogooreck Api implementation #1
Conversation
oskardudycz
force-pushed
the
Ogooreck_Api
branch
2 times, most recently
from
b61d2f6 to
e3b10b6
Compare
oskardudycz
changed the title
oskardudycz
force-pushed
the
Ogooreck_Api
branch
from
e3b10b6 to
82d5177
Compare
README.md
Outdated
| @@ -1,2 +1,36 @@ | |||
| # Ogooreck | |||
|
|
|||
| Sneaky Test library | |||
There was a problem hiding this comment.
More description here about what the library does would be useful
There was a problem hiding this comment.
Added more in recent commit 🙂
| <Project Sdk="Microsoft.NET.Sdk"> | ||
|
|
||
| <PropertyGroup> | ||
| <TargetFramework>net6.0</TargetFramework> |
There was a problem hiding this comment.
As this is going to be a public library, I would suggest something like this...
<PropertyGroup>
<TargetFramework>net6.0</TargetFramework>
<PackageProjectUrl>
https://github.com/oskardudycz/Ogooreck
</PackageProjectUrl>
<RepositoryUrl>
https://github.com/oskardudycz/Ogooreck.git
</RepositoryUrl>
<PublishRepositoryUrl>true</PublishRepositoryUrl>
<Product>Ogooreck</Product>
<GenerateDocumentationFile>true</GenerateDocumentationFile
<EmbedUntrackedSources>true</EmbedUntrackedSources
<AllowedOutputExtensionsInPackageBuildOutputFolder>
$(AllowedOutputExtensionsInPackageBuildOutputFolder);.pdb
</AllowedOutputExtensionsInPackageBuildOutputFolder>
<IncludeSymbols>true</IncludeSymbols>
<SymbolPackageFormat>snupkg</SymbolPackageFormat
<TreatWarningsAsErrors>true</TreatWarningsAsErrors>
<WarningsAsErrors />
<LangVersion>10.0</LangVersion>
</PropertyGroup>
<ItemGroup>
<PackageReference Include="FluentAssertions" Version="6.6.0"/>
<PackageReference Include="Microsoft.AspNetCore.Mvc.Testing" Version="6.0.4"/>
<PackageReference Include="Microsoft.SourceLink.GitHub" Version="1.1.1">
<PrivateAssets>all</PrivateAssets>
</PackageReference>
</ItemGroup>
|
|
||
| namespace Ogooreck.API; | ||
|
|
||
| public static class ApiSpecification |
There was a problem hiding this comment.
The class has no documentation comments, which would extremely useful for new users of your library
There was a problem hiding this comment.
This will come in a separate PR. I created a dedicated issue for it: #2.
| /////////////////// | ||
| //// GIVEN //// | ||
| /////////////////// | ||
| public static Func<HttpRequestMessage, HttpRequestMessage> URI(string uri) => |
There was a problem hiding this comment.
The correct camel-casing would be Uri, wouldn't it?
There was a problem hiding this comment.
Same comment as #1 (comment).
src/Ogooreck/API/ApiSpecification.cs
Outdated
| public static Action<HttpResponseMessage> PRECONDITION_FAILED = HTTP_STATUS(HttpStatusCode.PreconditionFailed); | ||
| public static Action<HttpResponseMessage> METHOD_NOT_ALLOWED = HTTP_STATUS(HttpStatusCode.MethodNotAllowed); | ||
|
|
||
| public static Action<HttpResponseMessage> HTTP_STATUS(HttpStatusCode status) => |
There was a problem hiding this comment.
Personally, I'm not a fan of the "all caps" naming that you've got throughout this file...would prefer camel-casing, which I believe is the Microsoft code-style standard for .Net
There was a problem hiding this comment.
Thank you for the suggestion. I'll keep that in mind, and gather also other feedback around that. I like that it makes tests more explicit and the specific parts highlighted, so I'll keep it as it is for now.
| response => response.StatusCode.Should().Be(status); | ||
| } | ||
|
|
||
| public class ApiSpecification<TProgram>: IDisposable where TProgram : class |
There was a problem hiding this comment.
Separates file for separate classes?
There was a problem hiding this comment.
I think that for now it's simple enough to keep it in the same file, but in the long term, I agree, it'd be good to keep it separated when it starts to grow.
No description provided.