From 807998a66bc9cd1d195a69872577e1f23c000bfa Mon Sep 17 00:00:00 2001 From: Richard Boyd Date: Tue, 3 Dec 2019 18:34:45 -0500 Subject: [PATCH] feat: Add C# StepFunctions Job Poller (#174) * Add C# StepFunctions Job Poller * semantic fixes --- csharp/stepfunctions-job-poller/.gitignore | 342 ++++++++++++++++++ csharp/stepfunctions-job-poller/README.md | 27 ++ csharp/stepfunctions-job-poller/cdk.json | 3 + .../src/StepfunctionsJobPoller.sln | 34 ++ .../src/StepfunctionsJobPoller/Program.cs | 19 + .../StepfunctionsJobPoller.csproj | 19 + .../StepfunctionsJobPollerConstruct.cs | 36 ++ .../StepfunctionsJobPollerStack.cs | 62 ++++ 8 files changed, 542 insertions(+) create mode 100644 csharp/stepfunctions-job-poller/.gitignore create mode 100644 csharp/stepfunctions-job-poller/README.md create mode 100644 csharp/stepfunctions-job-poller/cdk.json create mode 100644 csharp/stepfunctions-job-poller/src/StepfunctionsJobPoller.sln create mode 100644 csharp/stepfunctions-job-poller/src/StepfunctionsJobPoller/Program.cs create mode 100644 csharp/stepfunctions-job-poller/src/StepfunctionsJobPoller/StepfunctionsJobPoller.csproj create mode 100644 csharp/stepfunctions-job-poller/src/StepfunctionsJobPoller/StepfunctionsJobPollerConstruct.cs create mode 100644 csharp/stepfunctions-job-poller/src/StepfunctionsJobPoller/StepfunctionsJobPollerStack.cs diff --git a/csharp/stepfunctions-job-poller/.gitignore b/csharp/stepfunctions-job-poller/.gitignore new file mode 100644 index 000000000..f555633ea --- /dev/null +++ b/csharp/stepfunctions-job-poller/.gitignore @@ -0,0 +1,342 @@ +# CDK asset staging directory +.cdk.staging +cdk.out + +# Created by https://www.gitignore.io/api/csharp + +### Csharp ### +## Ignore Visual Studio temporary files, build results, and +## files generated by popular Visual Studio add-ons. +## +## Get latest from https://github.com/github/gitignore/blob/master/VisualStudio.gitignore + +# User-specific files +*.suo +*.user +*.userosscache +*.sln.docstates + +# User-specific files (MonoDevelop/Xamarin Studio) +*.userprefs + +# Build results +[Dd]ebug/ +[Dd]ebugPublic/ +[Rr]elease/ +[Rr]eleases/ +x64/ +x86/ +bld/ +[Bb]in/ +[Oo]bj/ +[Ll]og/ + +# Visual Studio 2015/2017 cache/options directory +.vs/ +# Uncomment if you have tasks that create the project's static files in wwwroot +#wwwroot/ + +# Visual Studio 2017 auto generated files +Generated\ Files/ + +# MSTest test Results +[Tt]est[Rr]esult*/ +[Bb]uild[Ll]og.* + +# NUNIT +*.VisualState.xml +TestResult.xml + +# Build Results of an ATL Project +[Dd]ebugPS/ +[Rr]eleasePS/ +dlldata.c + +# Benchmark Results +BenchmarkDotNet.Artifacts/ + +# .NET Core +project.lock.json +project.fragment.lock.json +artifacts/ + +# StyleCop +StyleCopReport.xml + +# Files built by Visual Studio +*_i.c +*_p.c +*_i.h +*.ilk +*.meta +*.obj +*.iobj +*.pch +*.pdb +*.ipdb +*.pgc +*.pgd +*.rsp +*.sbr +*.tlb +*.tli +*.tlh +*.tmp +*.tmp_proj +*.log +*.vspscc +*.vssscc +.builds +*.pidb +*.svclog +*.scc + +# Chutzpah Test files +_Chutzpah* + +# Visual C++ cache files +ipch/ +*.aps +*.ncb +*.opendb +*.opensdf +*.sdf +*.cachefile +*.VC.db +*.VC.VC.opendb + +# Visual Studio profiler +*.psess +*.vsp +*.vspx +*.sap + +# Visual Studio Trace Files +*.e2e + +# TFS 2012 Local Workspace +$tf/ + +# Guidance Automation Toolkit +*.gpState + +# ReSharper is a .NET coding add-in +_ReSharper*/ +*.[Rr]e[Ss]harper +*.DotSettings.user + +# JustCode is a .NET coding add-in +.JustCode + +# TeamCity is a build add-in +_TeamCity* + +# DotCover is a Code Coverage Tool +*.dotCover + +# AxoCover is a Code Coverage Tool +.axoCover/* +!.axoCover/settings.json + +# Visual Studio code coverage results +*.coverage +*.coveragexml + +# NCrunch +_NCrunch_* +.*crunch*.local.xml +nCrunchTemp_* + +# MightyMoose +*.mm.* +AutoTest.Net/ + +# Web workbench (sass) +.sass-cache/ + +# Installshield output folder +[Ee]xpress/ + +# DocProject is a documentation generator add-in +DocProject/buildhelp/ +DocProject/Help/*.HxT +DocProject/Help/*.HxC +DocProject/Help/*.hhc +DocProject/Help/*.hhk +DocProject/Help/*.hhp +DocProject/Help/Html2 +DocProject/Help/html + +# Click-Once directory +publish/ + +# Publish Web Output +*.[Pp]ublish.xml +*.azurePubxml +# Note: Comment the next line if you want to checkin your web deploy settings, +# but database connection strings (with potential passwords) will be unencrypted +*.pubxml +*.publishproj + +# Microsoft Azure Web App publish settings. Comment the next line if you want to +# checkin your Azure Web App publish settings, but sensitive information contained +# in these scripts will be unencrypted +PublishScripts/ + +# NuGet Packages +*.nupkg +# The packages folder can be ignored because of Package Restore +**/[Pp]ackages/* +# except build/, which is used as an MSBuild target. +!**/[Pp]ackages/build/ +# Uncomment if necessary however generally it will be regenerated when needed +#!**/[Pp]ackages/repositories.config +# NuGet v3's project.json files produces more ignorable files +*.nuget.props +*.nuget.targets + +# Microsoft Azure Build Output +csx/ +*.build.csdef + +# Microsoft Azure Emulator +ecf/ +rcf/ + +# Windows Store app package directories and files +AppPackages/ +BundleArtifacts/ +Package.StoreAssociation.xml +_pkginfo.txt +*.appx + +# Visual Studio cache files +# files ending in .cache can be ignored +*.[Cc]ache +# but keep track of directories ending in .cache +!*.[Cc]ache/ + +# Others +ClientBin/ +~$* +*~ +*.dbmdl +*.dbproj.schemaview +*.jfm +*.pfx +*.publishsettings +orleans.codegen.cs + +# Including strong name files can present a security risk +# (https://github.com/github/gitignore/pull/2483#issue-259490424) +#*.snk + +# Since there are multiple workflows, uncomment next line to ignore bower_components +# (https://github.com/github/gitignore/pull/1529#issuecomment-104372622) +#bower_components/ + +# RIA/Silverlight projects +Generated_Code/ + +# Backup & report files from converting an old project file +# to a newer Visual Studio version. Backup files are not needed, +# because we have git ;-) +_UpgradeReport_Files/ +Backup*/ +UpgradeLog*.XML +UpgradeLog*.htm +ServiceFabricBackup/ +*.rptproj.bak + +# SQL Server files +*.mdf +*.ldf +*.ndf + +# Business Intelligence projects +*.rdl.data +*.bim.layout +*.bim_*.settings +*.rptproj.rsuser + +# Microsoft Fakes +FakesAssemblies/ + +# GhostDoc plugin setting file +*.GhostDoc.xml + +# Node.js Tools for Visual Studio +.ntvs_analysis.dat +node_modules/ + +# Visual Studio 6 build log +*.plg + +# Visual Studio 6 workspace options file +*.opt + +# Visual Studio 6 auto-generated workspace file (contains which files were open etc.) +*.vbw + +# Visual Studio LightSwitch build output +**/*.HTMLClient/GeneratedArtifacts +**/*.DesktopClient/GeneratedArtifacts +**/*.DesktopClient/ModelManifest.xml +**/*.Server/GeneratedArtifacts +**/*.Server/ModelManifest.xml +_Pvt_Extensions + +# Paket dependency manager +.paket/paket.exe +paket-files/ + +# FAKE - F# Make +.fake/ + +# JetBrains Rider +.idea/ +*.sln.iml + +# CodeRush +.cr/ + +# Python Tools for Visual Studio (PTVS) +__pycache__/ +*.pyc + +# Cake - Uncomment if you are using it +# tools/** +# !tools/packages.config + +# Tabs Studio +*.tss + +# Telerik's JustMock configuration file +*.jmconfig + +# BizTalk build output +*.btp.cs +*.btm.cs +*.odx.cs +*.xsd.cs + +# OpenCover UI analysis results +OpenCover/ + +# Azure Stream Analytics local run output +ASALocalRun/ + +# MSBuild Binary and Structured Log +*.binlog + +# NVidia Nsight GPU debugger configuration file +*.nvuser + +# MFractors (Xamarin productivity tool) working folder +.mfractor/ + +# Local History for Visual Studio +.localhistory/ + + +# End of https://www.gitignore.io/api/csharp \ No newline at end of file diff --git a/csharp/stepfunctions-job-poller/README.md b/csharp/stepfunctions-job-poller/README.md new file mode 100644 index 000000000..33c4ce913 --- /dev/null +++ b/csharp/stepfunctions-job-poller/README.md @@ -0,0 +1,27 @@ + +# Stepfunctions Job Poller + +--- + +![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge) + +> **This is an experimental example. It may not build out of the box** +> +> This examples is built on Construct Libraries marked "Experimental" and may not be updated for latest breaking changes. +> +> If build is unsuccessful, please create an [issue](https://github.com/aws-samples/aws-cdk-examples/issues/new) so that we may debug the problem + +--- + + +This example creates a basic Stepfunction workflow that starts a task and then listens at regular intervals for completion, then reports completion and status. + +## Build + +To build this app, you need to be in this example's root folder. Then run the following: +```bash +dotnet build src +cdk deploy StepfunctionsJobPollerStack +``` + +Enjoy! diff --git a/csharp/stepfunctions-job-poller/cdk.json b/csharp/stepfunctions-job-poller/cdk.json new file mode 100644 index 000000000..15399d264 --- /dev/null +++ b/csharp/stepfunctions-job-poller/cdk.json @@ -0,0 +1,3 @@ +{ + "app": "dotnet run -p src/StepfunctionsJobPoller/StepfunctionsJobPoller.csproj" +} diff --git a/csharp/stepfunctions-job-poller/src/StepfunctionsJobPoller.sln b/csharp/stepfunctions-job-poller/src/StepfunctionsJobPoller.sln new file mode 100644 index 000000000..a18c58e79 --- /dev/null +++ b/csharp/stepfunctions-job-poller/src/StepfunctionsJobPoller.sln @@ -0,0 +1,34 @@ + +Microsoft Visual Studio Solution File, Format Version 12.00 +# Visual Studio 15 +VisualStudioVersion = 15.0.26124.0 +MinimumVisualStudioVersion = 15.0.26124.0 +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "StepfunctionsJobPoller", "StepfunctionsJobPoller\StepfunctionsJobPoller.csproj", "{02459B83-7B22-4CEC-8CE6-C05C96E45952}" +EndProject +Global + GlobalSection(SolutionConfigurationPlatforms) = preSolution + Debug|Any CPU = Debug|Any CPU + Debug|x64 = Debug|x64 + Debug|x86 = Debug|x86 + Release|Any CPU = Release|Any CPU + Release|x64 = Release|x64 + Release|x86 = Release|x86 + EndGlobalSection + GlobalSection(SolutionProperties) = preSolution + HideSolutionNode = FALSE + EndGlobalSection + GlobalSection(ProjectConfigurationPlatforms) = postSolution + {02459B83-7B22-4CEC-8CE6-C05C96E45952}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {02459B83-7B22-4CEC-8CE6-C05C96E45952}.Debug|Any CPU.Build.0 = Debug|Any CPU + {02459B83-7B22-4CEC-8CE6-C05C96E45952}.Debug|x64.ActiveCfg = Debug|Any CPU + {02459B83-7B22-4CEC-8CE6-C05C96E45952}.Debug|x64.Build.0 = Debug|Any CPU + {02459B83-7B22-4CEC-8CE6-C05C96E45952}.Debug|x86.ActiveCfg = Debug|Any CPU + {02459B83-7B22-4CEC-8CE6-C05C96E45952}.Debug|x86.Build.0 = Debug|Any CPU + {02459B83-7B22-4CEC-8CE6-C05C96E45952}.Release|Any CPU.ActiveCfg = Release|Any CPU + {02459B83-7B22-4CEC-8CE6-C05C96E45952}.Release|Any CPU.Build.0 = Release|Any CPU + {02459B83-7B22-4CEC-8CE6-C05C96E45952}.Release|x64.ActiveCfg = Release|Any CPU + {02459B83-7B22-4CEC-8CE6-C05C96E45952}.Release|x64.Build.0 = Release|Any CPU + {02459B83-7B22-4CEC-8CE6-C05C96E45952}.Release|x86.ActiveCfg = Release|Any CPU + {02459B83-7B22-4CEC-8CE6-C05C96E45952}.Release|x86.Build.0 = Release|Any CPU + EndGlobalSection +EndGlobal diff --git a/csharp/stepfunctions-job-poller/src/StepfunctionsJobPoller/Program.cs b/csharp/stepfunctions-job-poller/src/StepfunctionsJobPoller/Program.cs new file mode 100644 index 000000000..406604bc6 --- /dev/null +++ b/csharp/stepfunctions-job-poller/src/StepfunctionsJobPoller/Program.cs @@ -0,0 +1,19 @@ +using Amazon.CDK; +using System; +using System.Collections.Generic; +using System.Linq; + +namespace StepfunctionsJobPoller +{ + class Program + { + static void Main(string[] args) + { + var app = new App(); + + new StepfunctionsJobPollerStack(app, "StepfunctionsJobPollerStack"); + + app.Synth(); + } + } +} diff --git a/csharp/stepfunctions-job-poller/src/StepfunctionsJobPoller/StepfunctionsJobPoller.csproj b/csharp/stepfunctions-job-poller/src/StepfunctionsJobPoller/StepfunctionsJobPoller.csproj new file mode 100644 index 000000000..be732d6a8 --- /dev/null +++ b/csharp/stepfunctions-job-poller/src/StepfunctionsJobPoller/StepfunctionsJobPoller.csproj @@ -0,0 +1,19 @@ + + + + Exe + netcoreapp3.0 + + + + + + + + + + + + + + diff --git a/csharp/stepfunctions-job-poller/src/StepfunctionsJobPoller/StepfunctionsJobPollerConstruct.cs b/csharp/stepfunctions-job-poller/src/StepfunctionsJobPoller/StepfunctionsJobPollerConstruct.cs new file mode 100644 index 000000000..53ac28ab4 --- /dev/null +++ b/csharp/stepfunctions-job-poller/src/StepfunctionsJobPoller/StepfunctionsJobPollerConstruct.cs @@ -0,0 +1,36 @@ +using Amazon.CDK; +using Amazon.CDK.AWS.IAM; +using Amazon.CDK.AWS.S3; +using System.Collections.Generic; +using System.Linq; + +namespace StepfunctionsJobPoller +{ + public class StepfunctionsJobPollerConstructProps + { + public int BucketCount { get; set; } + } + + public class StepfunctionsJobPollerConstruct : Construct + { + private readonly IEnumerable _buckets; + + // A simple construct that contains a collection of AWS S3 buckets. + public StepfunctionsJobPollerConstruct(Construct scope, string id, StepfunctionsJobPollerConstructProps props) : base(scope, id) + { + _buckets = Enumerable.Range(0, props.BucketCount) + .Select(i => new Bucket(this, $"Bucket{i}")) + .ToList(); + + } + + // Give the specified principal read access to the buckets in this construct. + public void GrantRead(IPrincipal principal) + { + foreach (Bucket bucket in _buckets) + { + bucket.GrantRead(principal, "*"); + } + } + } +} diff --git a/csharp/stepfunctions-job-poller/src/StepfunctionsJobPoller/StepfunctionsJobPollerStack.cs b/csharp/stepfunctions-job-poller/src/StepfunctionsJobPoller/StepfunctionsJobPollerStack.cs new file mode 100644 index 000000000..5a81fd6be --- /dev/null +++ b/csharp/stepfunctions-job-poller/src/StepfunctionsJobPoller/StepfunctionsJobPollerStack.cs @@ -0,0 +1,62 @@ +using Amazon.CDK; +using Amazon.CDK.AWS.StepFunctions; +using Amazon.CDK.AWS.StepFunctions.Tasks; + +namespace StepfunctionsJobPoller +{ + public class StepfunctionsJobPollerStack : Stack + { + public StepfunctionsJobPollerStack(Construct scope, string id, IStackProps props = null) : base(scope, id, props) + { + var submitJobActivity = new Activity(this, "SubmitJob"); + var checkJobActivity = new Activity(this, "CheckJob"); + + var submitJob = new Task(this, "Submit Job", new TaskProps + { + Task = new InvokeActivity(submitJobActivity), + ResultPath= "$.guid" + }); + + var waitX = new Wait(this, "Wait X Seconds", new WaitProps + { + Time = WaitTime.SecondsPath("$.wait_time") + }); + + var getStatus = new Task(this, "Get Job Status", new TaskProps + { + Task = new InvokeActivity(checkJobActivity), + InputPath = "$.guid", + ResultPath = "$.status" + }); + + var isComplete = new Choice(this, "Job Complete?"); + + var jobFailed = new Fail(this, "Job Failed", new FailProps + { + Cause = "AWS Batch Job Failed", + Error = "DescribeJob returned FAILED" + }); + + var finalStatus = new Task(this, "Get Final Job Status", new TaskProps + { + Task = new InvokeActivity(checkJobActivity), + InputPath = "$.guid" + }); + + var chain = Chain + .Start(submitJob) + .Next(waitX) + .Next(getStatus) + .Next(isComplete + .When(Condition.StringEquals("$.status", "FAILED"), jobFailed) + .When(Condition.StringEquals("$.status", "SUCCEEDED"), finalStatus) + .Otherwise(waitX)); + + new StateMachine(this, "StateMachine", new StateMachineProps + { + Definition = chain, + Timeout = Duration.Seconds(30) + }); + } + } +}