mytrout / pipelines Goto Github PK

View Code? Open in Web Editor NEW

3.0 1.0 2.0 1.77 MB

Provides a non-HTTP-based request/response pipeline similar to the ASP.NET Core request pipeline.

License: MIT License

C# 99.96% TSQL 0.04%

pipelines's Introduction

Pipelines

Introduction

Provides a non-HTTP pipeline similar to the ASP.NET Core request pipeline.

MyTrout.Pipelines targets .NET 6.0

If three steps named M1, M2, and M3 were added to the Pipeline, here is the execution path for the code.

The Pipeline automatically adds the NoOpStep as the last step in the Pipeline.

BREAKING CHANGES INTRODUCED WITH 4.0.0

See Breaking Changes for 4.0.0

Installing via NuGet

Install-Package MyTrout.Pipelines

Software dependencies

1. Microsoft.Extensions.Configuration.Abstractions 6.0.0
2. Microsoft.Extensions.Configuration.Binder 6.0.0
3. Microsoft.Extensions.DependencyInjection.Abstractions 6.0.0
4. Microsoft.Extensions.Logging.Abstractions 6.0.0

All software dependencies listed above use the MIT License.

How do I use Pipelines?

Please refer to the Pipelines.Core for details on the basics of how to use Pipelines.

How do I write Steps?

Please refer to the Steps for more details on how to write steps.

How do I use Pipelines with Console Applications / Generic Host?

Please refer to the Pipeline.Hosting for more details on how to use Pipelines with Console applications.

Build the software locally.

1. Clone the software from the Pipelines repository.
2. Build the software in Visual Studio 2022 v17.0 or higher to pull down all of the dependencies from nuget.org.
3. In Visual Studio, run all tests.  All of the should pass.
4. If you have Visual Studio Enterprise 2022, analyze the code coverage; it should be 100%.

Build the software in Github

TODO ->

pipelines's People

Contributors

Stargazers

Watchers

Forkers

bubdm

pipelines's Issues

Create a new step for the Microsoft.Extensions.Logging.Serilog named AddAdditionalSerilogLoggingContext.

Correct build badges for Pipeline components.

The following components still point to Azure DevOps:
MyTrout.Pipelines.Steps.Azure.ServiceBus

The following components have a broken link for the build badge:
MyTrout.Pipelines.Steps.Cryptography

Write a workflow that will upgrade all projects, unit tests and versioning for .NET 7.0.0-preview.1.

src/*.csproj files should add the .net 7.0 preview to the already existing .NET 6.0 projects.
test/*csproj files should run both .NET 6.0 and .NET 7.0-preview instances of the projects.
changelog.md should add the new version at the top of the file with a description of the changes in the new version.
readme.md files should be upgraded to reflect that .NET 5.0, .NET 6.0 and .NET 7.0 are supported.
.github/workflows/*.yaml should include .NET 7.0 in the installation step for .NET SDKs.
.github/workflows/*.yaml should include "include-prerelease: true" parameter in the installation step for .NET SDKs.
.github/workflows/*.yaml should add the suffix matching the .NET 7.0 version (such as -preview.1)
.github/workflows/*.yaml should add update the minor version +1 to reflect that new changes are included with the inclusion of .NET 7.0-preview.1 binaries.

Add debug logging to MyTrout.Pipelines.Hosting

Add debug logging to MyTrout.Pipelines.Steps.Cryptography

Add debug logging to MyTrout.Pipelines.Steps.IO.Files

Add debug logging to MyTrout.Pipelines.Steps

Add ability to create a directory to a new library called Pipelines.Steps.IO.Directories

Update unit tests for Steps.IO.Compression to move code coverage from 99.4% to 100%.

Details are located in the following URL:

https://sonarcloud.io/code?id=Pipelines.Steps.IO.Compression&selected=Pipelines.Steps.IO.Compression%3Asrc%2FOpenExistingZipArchiveFromStreamStep.cs

Correct issues with code coverage on Pipelines.Steps.Cryptography and altcover - currently showing 96.6% code coverage.

Correct issues with code coverage on Pipelines.Core and altcover - currently showing 0% code coverage.

Correct the Project URL and Repository URL for projects that are still pointing to Azure DevOps

Conditions of Acceptance

Replace the Project URL and Repository URL in Steps.Cryptography.
Replace the Project URL and Repository URL in Steps.IO.Files.
Replace the Project URL and Repository URL in Steps.IO.Compression.
Replace the Project URL and Repository URL in Steps.Azure.Blobs.

DisposeAsync is implemented incorrectly on AbstractStep{TStep}

Write a workflow that will change preview support to fully-released support for all projects, unit tests and versioning for .NET 7.0 when is finally released.

src/*.csproj files should add the .net 7.0 non-preview version to the already existing .NET 6.0 projects.
src/*.csproj files should remove all .net 7.0 preview versions from the already existing .NET 6.0 projects.
test/*csproj files should run both .NET 6.0 and .NET 7.0 non-preview instances of the projects.
changelog.md should add the new version at the top of the file with a description of the changes in the new version.
readme.md files should be upgraded to reflect that .NET 6.0 and .NET 7.0 non-preview are supported.
.github/workflows/*.yaml should include .NET 7.0 non-preview in the installation step for .NET SDKs.
.github/workflows/*.yaml should set "include-prerelease: false" parameter in the installation step for .NET SDKs.
.github/workflows/*.yaml should remove any suffix associated with the .NET 7.0 version.
.github/workflows/*.yaml should update the minor version +1 to reflect that new changes are included with the inclusion of .NET 7.0 binaries.

Add ability to delete a directory to a new library called Pipelines.Steps.IO.Directories

Upgrade all delivered code to .NET 6.0

Add Step to send e-mails with data from Pipeline Context.

Create a set of steps for MyTrout.Steps.Pipelines.Communications.Grpc to UploadStreamToGrpcEndpoint and DownloadStreamFromGrpcEndpoint

Add ability to check file existence in Steps.IO.Files.

Add debug logging to MyTrout.Pipelines.Steps,Azure.ServiceBus

Correct the 94.8% Code Coverage for Pipelines.Steps.Data in SonarCloud.io

Several classes in the Test project are not marked with ExcludeFromCodeCoverage:
SaveContextToDatabaseOptionsTests
SaveContextToDatabaseStepTests
SupplementContextWithDatabaseRecordOptionTests
SupplementContextWithDatabaseRecordStepTests
ValidationExtensionsTests

Create a set of steps for MyTrout.Pipelines.Steps.Communications.SOAP to UploadStreamToSoapEndpoint and DownloadStreamFromSoapEndpoint

Correct or suppress 3 Code Smells in Pipelines.Hosting in SonarCloud.io (Low Priority -- All of the issues in Test Code)

DisposeAsync issues - CA1816 - 3

Update all builds with if-no-files-found on the Upload NuPkg step.

See this location https://github.com/actions/upload-artifact for more details...

New version should look like this:
- name: Upload nupkg
uses: actions/upload-artifact@v2
with:
name: nupkg
path: ${{ env.WORKING_DIRECTORY }}/**/bin/Release/.nupkg
if-no-files-found: error
if: "github.ref == 'refs/heads/master' && github.event.pull_request.user.login != 'dependabot[bot]' && !contains(github.event.push.commits..author, 'dependabot[bot]')"

On Pipelines.Core, combine the .NET 5.0 and 6.0 setup steps in the build to match Pipelines.Steps builds.

Create a step in MyTrout.Pipelines.Steps.Metrics, such as CaptureExecutionTimeMetricStep.

Refactor all Resources.tt T4 Templates to use NamespaceHint instead of hard-coded namespace.

After successful work with Steps.Data, upgrade all code coverage metrics from OpenCover to AltCover to ensure 100% code coverage.

Correct or suppress 9 Code Smells in Pipelines.Core in SonarCloud.io

Add ability to check for the existence of a directory to a new library called Pipelines.Steps.IO.Directories

Add debug logging to MyTrout.Pipelines.Core

All Resources.tt files that generate the Resources.cs file state that the code was generated by .NET Standard 2.0 instead of .NET 5.0.

Correct issues with code coverage on Pipelines.Steps.IO.Compression and altcover - currently showing 98.0% code coverage.

Azure SQL Server is no longer available in Central US for my Azure Subscription. Move Steps.Data to East US for support.

Add debug logging to MyTrout.Pipelines.Steps.Azure.Blobs

Suppress CA2254 in Steps.IO.Compression

My understanding of the original intent of this rule was to prevent developers from concatenating strings into logging messages.

The current implementation basically says that if the string is not hard-coded (and therefore not resource-driven and/or culture-aware), the CA2254 will be raised.

I have commented that I don't believe this should be the intent of the rule and if it is, that my team will simply suppress it as it generates too many false positives when using resource-driven strings.

Review and update Pipelines.Steps.Data README.md with correct .NET version and links to Pipelines.Core instead of Pipelines.Steps.Core.

Correct or suppress 2 Code Smells in Pipelines.Steps.IO.Command in SonarCloud.io

Logging static message - CA2254: 2

Create a set of steps for MyTrout.Pipelines.Steps.Communications.SFTP to UploadStreamToSftpEndpoint and DownloadStreamFromSftpEndpoint.

Add ability to move a directory to a new library called Pipelines.Steps.IO.Directories

Create a set of steps for MyTrout.Steps.Pipelines.Communications.REST to UploadStreamToRestEndpoint and DownloadStreamFromRestEndpoint

Write a workflow that will remove support in all projects, unit tests and versioning for .NET 5.0 when it is no longer supported.

src/*.csproj files should remove the .net 5.0 from the already existing .NET 6.0 projects.
test/*csproj files should remove any references to .NET 5.0 in test projects.
changelog.md should add the new version at the top of the file with a description of the changes in the new version.
readme.md files should remove .NET 5.0 from supported versions.
.github/workflows/*.yaml should remove .NET 5.0 in the installation step for .NET SDKs.
.github/workflows/*.yaml should not alter any prefixes, if they exist.
.github/workflows/*.yaml should set the major version + 1, and minor/patch versions to 0.to reflect that new breaking changes are included with the removal of .NET 5.0 libraries.