This repository covers .NET Core 2.2 HTTP-related modules and classes libraries that are used in other projects.
Want to start contributing? Read the Build Process, How to Use In Projects and Documentation sections before anything!
- Libraries Dependencies
- Versions
- Build Process
- How to Use In Projects
- Changelog
- To Do
- Documentation
- Testing
- ClosedXML 0.94.2
- Vsxmd 1.4.1
- Microsoft.NET.Test.Sdk 16.1.1
- NUnit 3.12.0
- NUnit3TestAdapter 3.13.0
All compiled versions of this library is released as a NuGet .NET library project package, which contains the mapping of methods and the respective assembly binary file.
In order to get the output NuGet and its related files, clone this repository and build the project. Release files and the NuGet package will be found at CustomHttpWrapperLibrary\bin\Release folder.
Details of build process can be found at build process topic.
The build process of this library uses two batches processes for a pre-build and a post-build, all in order to reinstall the library locally using a local feed repository. The basic process can be seen in CustomHttpWrapperLibrary.csproj file in the following lines:
<PropertyGroup>
<PostBuildEventDependsOn>
$(PostBuildEventDependsOn);
PostBuildMacros;
</PostBuildEventDependsOn>
</PropertyGroup>
<Target Name="PreBuild" BeforeTargets="PreBuildEvent" Condition="'$(Configuration)|$(Platform)'=='Release|AnyCPU'">
<Exec Command="call "$(SolutionDir)scripts\backupCSharpOldPackages.bat" $(SolutionDir) CustomHttpWrapperLibrary\ bin\Release\ $(TargetFramework) Versions\ $(PreviousVersion)" />
</Target>
<Target Name="PostBuild" AfterTargets="Pack" Condition="'$(Configuration)|$(Platform)'=='Release|AnyCPU'">
<Exec Command="call "$(SolutionDir)scripts\buildCopyCSharpPackages.bat" $(SolutionDir) $(ProjectName) bin\Release\ $(TargetFramework) "<LOCAL_FEED_REPOSITORY_FOLDER>\CustomHttpWrapperLibrary\" $(Version) docs\versions\ $(NuGetCustomPath) <LOCAL_FEED_REPOSITORY_FOLDER>" />
</Target>
The steps are the following:
1. Go to CustomHttpWrapperLibrary.csproj file and change the item called for the NuGet location path installed in your machine. If you can't find it, download a Portable version and save in a folder you can rely on, which will demand you to edit the NuGet location path again in the .csproj.
2. Before building any release version, a backup version of the previous version is made automatically through a backupCSharpOldPackages.bat file. Using a property in the main .csproj file, all release files are copied to a /Versions/X.X.X folder inside CustomHttpWrapperLibrary/ folder (not synced with Git). For more details, check the backupCSharpOldPackages.bat file.
<Target Name="PreBuild" BeforeTargets="PreBuildEvent" Condition="'$(Configuration)|$(Platform)'=='Release|AnyCPU'">
<Exec Command="call "$(SolutionDir)scripts\backupCSharpOldPackages.bat" $(SolutionDir) CustomHttpWrapperLibrary\ bin\Release\ $(TargetFramework) Versions\ $(PreviousVersion)" />
</Target>
3. After that, select the configuration environment option as Release (in the toolbar, near Any CPU and Start)
4. Go to the option Build in the tabs toolbar and select the option Build CustomHttpWrapperLibrary
5. After the nuget build/packing step, a post-build event is triggered, which calls the buildCopyCSharpPackages.bat script. Using the change property in the main .csproj file, this batch script (re)installs the nuget package version to a local feed repository (<LOCAL_FEED_REPOSITORY_FOLDER>) and then copies the standard2.0/ folder from release to the local feed repository in the specific version created folder for the library. After that, the generated XML/Markdown code documentation is copied to the docs version folder docs/Versions/X.X.X/.
<Target Name="PostBuild" AfterTargets="Pack" Condition="'$(Configuration)|$(Platform)'=='Release|AnyCPU'">
<Exec Command="call "$(SolutionDir)scripts\buildCopyCSharpPackages.bat" $(SolutionDir) $(ProjectName) bin\Release\ $(TargetFramework) "<LOCAL_FEED_REPOSITORY_FOLDER>\CustomHttpWrapperLibrary\" $(Version) docs\versions\ $(NuGetCustomPath) <LOCAL_FEED_REPOSITORY_FOLDER>" />
</Target>
TBD/TBT. The goal is to test the following build steps :
# Make sure you have .NET Core 2.2 version installed
dotnet build -c Release # Debug is building properly, but Release has to override .bat execs
dotnet pack1. Since this is a private package, you won't find it in nuget public repository. The way it's being used is through local feed repositories. To configure the local feed repository in Visual Studio, go through the following steps (on Windows):
-
Go to Tools > NuGet Package Manager > Package Manager Settings. In there add the folder you will store your local NuGet package repositories.
-
Go to Tools > NuGet Package Manager > Manage NuGet Packages for Solution. Select the local drive you setted and install the CustomHttpWrapperLibrary in your project.
2. After installation of the package and respective nested ones, import any of the desired folders below into your project:
using CustomHttpWrapperLibrary.BaseHttpClient;
using CustomHttpWrapperLibrary.BaseHttpWebRequest;
using CustomHttpWrapperLibrary.Helpers.MediaTypeNamesHelper.Text;
using CustomHttpWrapperLibrary.Helpers.MediaTypeNamesHelper.Application;
using CustomHttpWrapperLibrary.Helpers.MediaTypeNamesHelper.Image;
using CustomHttpWrapperLibrary.Helpers.MediaTypeNamesHelper.Web;
using CustomHttpWrapperLibrary.Helpers.MediaTypeNamesHelper.Encoding;
using CustomHttpWrapperLibrary.Utils.IOService;
using CustomHttpWrapperLibrary.Utils.SerializationService;
using CustomHttpWrapperLibrary.Utils.WebService;Methods documentation for each one of the folders can be found with CustomHttpWrapperLibrary Markdown file inside docs folder.
- Beta 0.1.0 [24/05/19]: Organization for HTTP client methods.
- Beta 0.2.0 [13/06/19]: Added method GetAsyncFullResponse for full payload verification + Started unit testing.
- Beta 0.2.1 [14/06/19]: Bug fixes regarding HttpClientHandler appended to HttpClient instance + Bug fixes.
- Beta 0.3.0 [26/07/19]: Added Multipart FormData requests.
1. Expand unit test coverage
2. Implement methods for PUT, DELETE
This project solution already contains a glued testing project (located at folder CustomHttpWrapperLibrary.Tests) based on NUnit 3 framework. Everytime you want to start testing, you need to compile the project with the project context as Debug, which will load automatically all existent coded tests directly into the Text Explorer tab. After that, you are ready to filter, debug and run tests accordingly to your needs - the tests execution can also be done without Visual Studio GUI, which will demand dotnet command line commands.
If you wish to study and understand the fundamentals of testing using NUnit, a tutorial using Visual Studio can be read here and another using only .NET command line can be read here.