doc(example): examples dir, and RawAESKeyring example #281

MatthewBennington · 2020-04-24T18:16:51Z

Issue #, if available: resolves #263

Description of changes: Created example directory and project, and created AES Example

Squash/merge commit message, if applicable:

Create examples directory
Create examples project file
Create RawAESKeyringExample
Create ExampleUtils

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

- Create examples directory and project - Create RawAESKeyringExample.cs - Create ExampleUtils.cs

lavaleri · 2020-04-24T18:34:30Z

AWS CodeBuild CI Report

CodeBuild project: DafnyESDK
Commit ID: 8c4dfe9
Result: SUCCEEDED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

lavaleri · 2020-04-24T21:17:07Z

AWS CodeBuild CI Report

CodeBuild project: DafnyESDK
Commit ID: 3cd88c5
Result: FAILED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

examples/dotnet/RawAESKeyring/RawAESKeyringExample.cs

lavaleri · 2020-04-30T19:00:31Z

AWS CodeBuild CI Report

CodeBuild project: DafnyESDK
Commit ID: 892c8d6
Result: SUCCEEDED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

examples/dotnet/RawAESKeyring/RawAESKeyringExample.cs

Co-authored-by: Matt Bullock <[email protected]>

lavaleri · 2020-05-04T15:11:58Z

AWS CodeBuild CI Report

CodeBuild project: DafnyESDK
Commit ID: e854c9a
Result: SUCCEEDED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

Co-authored-by: Matt Bullock <[email protected]>

lavaleri · 2020-05-04T17:13:41Z

AWS CodeBuild CI Report

CodeBuild project: DafnyESDK
Commit ID: 1928216
Result: FAILED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

lavaleri · 2020-05-04T17:27:57Z

AWS CodeBuild CI Report

CodeBuild project: DafnyESDK
Commit ID: 1928216
Result: SUCCEEDED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

… into examples

lavaleri · 2020-05-04T21:51:47Z

AWS CodeBuild CI Report

CodeBuild project: DafnyESDK
Commit ID: fb379d4
Result: SUCCEEDED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

mattsb42-aws

With the qualifier that we need to remember to come back and add in the encryption context check, LGTM.

lavaleri · 2020-05-05T15:28:55Z

AWS CodeBuild CI Report

CodeBuild project: DafnyESDK
Commit ID: a722dd3
Result: SUCCEEDED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

… into examples

lavaleri · 2020-05-05T16:56:26Z

AWS CodeBuild CI Report

CodeBuild project: DafnyESDK
Commit ID: a4f540a
Result: SUCCEEDED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

mattsb42-aws

nit: we use the directory name "keyring" (singular) in Java and Python; we should be consistent.

examples/dotnet/README.md

mattsb42-aws · 2020-05-05T17:33:25Z

examples/dotnet/README.md

+1. Each example file MUST contain exactly one example.
+1. Each example filename MUST be descriptive.
+1. Each example file MUST contain a public class matching the filename.
+1. Each example file MUST contain a method called `run` that runs the example.


This framing reads a bit wrong in this case since it's not a method on the file, it's a method on the class. Looking over at Java, we have a similar wording issue there.

mattsb42-aws · 2020-05-05T17:34:27Z

examples/dotnet/README.md

+1. Each example filename MUST be descriptive.
+1. Each example file MUST contain a public class matching the filename.
+1. Each example file MUST contain a method called `run` that runs the example.
+1. Each example MUST be exercised by a `[Fact]` test method within its class.


I don't love this because it requires every example to repeat itself, but if this is the best way to approach this in .NET then ok.

I think it's probably the simplest/fastest solution in most languages, and I'd rather have this working to unblock more examples with an issue to improve it if we feel strongly about it.

It will be important to have test coverage metrics for this csproj in particular, no matter how we run them.

Having said that, this documentation is inconsistent - the stuff about run isn't sufficient, and not actually relevant since our CI assumes there's a [Fact] that will run it instead. I'm going to remove the items that aren't true YET, and we can put them back if and when we put different CI into place.

I'd like to keep the requirement of the entry point being named "run" so that we're consistent across languages.

robin-aws · 2020-05-06T16:44:39Z

With the qualifier that we need to remember to come back and add in the encryption context check, LGTM.

I'm confident we'll cover that as part of awslabs/aws-encryption-sdk-specification#96 (i.e. #289)

robin-aws · 2020-05-06T16:57:20Z

LGTM aside from @mattsb42-aws' latest suggestions!

Co-authored-by: Matt Bullock <[email protected]>

lavaleri · 2020-05-06T17:39:06Z

AWS CodeBuild CI Report

CodeBuild project: DafnyESDK
Commit ID: c1d89af
Result: SUCCEEDED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

lavaleri · 2020-05-06T17:39:35Z

AWS CodeBuild CI Report

CodeBuild project: DafnyESDK
Commit ID: c1d89af
Result: SUCCEEDED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

lavaleri · 2020-05-06T18:05:35Z

AWS CodeBuild CI Report

CodeBuild project: DafnyESDK
Commit ID: 58a465d
Result: SUCCEEDED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

lavaleri · 2020-05-06T18:35:56Z

AWS CodeBuild CI Report

CodeBuild project: DafnyESDK
Commit ID: 01150f1
Result: SUCCEEDED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

…n-sdk-dafny into examples

examples/dotnet/README.md

Co-authored-by: Matt Bullock <[email protected]>

lavaleri · 2020-05-06T20:33:55Z

AWS CodeBuild CI Report

CodeBuild project: DafnyESDK
Commit ID: 76d22d5
Result: FAILED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

lavaleri · 2020-05-06T20:47:44Z

AWS CodeBuild CI Report

CodeBuild project: DafnyESDK
Commit ID: eaecb1c
Result: SUCCEEDED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

lavaleri · 2020-05-06T20:47:52Z

AWS CodeBuild CI Report

CodeBuild project: DafnyESDK
Commit ID: eaecb1c
Result: SUCCEEDED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

lavaleri · 2020-05-06T21:00:17Z

AWS CodeBuild CI Report

CodeBuild project: DafnyESDK
Commit ID: 5d9f1d8
Result: SUCCEEDED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

doc(example): examples dir, and RawAESKeyring example

8c4dfe9

- Create examples directory and project - Create RawAESKeyringExample.cs - Create ExampleUtils.cs

fix(ci): Add examples to buildspec

3cd88c5

mattsb42-aws requested changes Apr 28, 2020

View reviewed changes

examples/dotnet/RawAESKeyring/RawAESKeyringExample.cs Outdated Show resolved Hide resolved

doc(example): Make RawAESKeyring example more like Python

892c8d6

mattsb42-aws requested changes May 1, 2020

View reviewed changes

Apply suggestions from code review

e854c9a

Co-authored-by: Matt Bullock <[email protected]>

Apply suggestions from code review

1928216

Co-authored-by: Matt Bullock <[email protected]>

Merge branch 'develop' of github.com:awslabs/aws-encryption-sdk-dafny…

fb379d4

… into examples

mattsb42-aws previously approved these changes May 4, 2020

View reviewed changes

doc(examples): Add example README

a722dd3

MatthewBennington dismissed mattsb42-aws’s stale review via a722dd3 May 5, 2020 15:13

Merge branch 'develop' of github.com:awslabs/aws-encryption-sdk-dafny…

a4f540a

… into examples

mattsb42-aws requested changes May 5, 2020

View reviewed changes

Update examples/dotnet/README.md

c1d89af

Co-authored-by: Matt Bullock <[email protected]>

Rename keyrings -> Keyrings, tweak examples rules

58a465d

Merge branch 'develop' into examples

01150f1

robin-aws added 2 commits May 6, 2020 13:28

Specified Run method for later automation

2614cec

Merge branch 'examples' of github.com:MatthewBennington/aws-encryptio…

76d22d5

…n-sdk-dafny into examples

mattsb42-aws reviewed May 6, 2020

View reviewed changes

examples/dotnet/README.md Outdated Show resolved Hide resolved

Update examples/dotnet/README.md

eaecb1c

Co-authored-by: Matt Bullock <[email protected]>

mattsb42-aws previously approved these changes May 6, 2020

View reviewed changes

Dummy commit to kick build

5d9f1d8

robin-aws dismissed mattsb42-aws’s stale review via 5d9f1d8 May 6, 2020 20:44

robin-aws approved these changes May 6, 2020

View reviewed changes

robin-aws merged commit dc27ba9 into aws:develop May 6, 2020

mattsb42-aws mentioned this pull request May 12, 2020

C# examples for all new canonical examples #317

Closed

19 tasks

ShubhamChaturvedi7 pushed a commit that referenced this pull request Mar 13, 2025

chore(testvector): Make testvectors run with MKP (#281)

f0205eb

doc(example): examples dir, and RawAESKeyring example #281

doc(example): examples dir, and RawAESKeyring example #281

Uh oh!

Conversation

MatthewBennington commented Apr 24, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

lavaleri commented Apr 24, 2020

AWS CodeBuild CI Report

Uh oh!

lavaleri commented Apr 24, 2020

AWS CodeBuild CI Report

Uh oh!

Uh oh!

lavaleri commented Apr 30, 2020

AWS CodeBuild CI Report

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

lavaleri commented May 4, 2020

AWS CodeBuild CI Report

Uh oh!

lavaleri commented May 4, 2020

AWS CodeBuild CI Report

Uh oh!

lavaleri commented May 4, 2020

AWS CodeBuild CI Report

Uh oh!

lavaleri commented May 4, 2020

AWS CodeBuild CI Report

Uh oh!

mattsb42-aws left a comment

Choose a reason for hiding this comment

Uh oh!

lavaleri commented May 5, 2020

AWS CodeBuild CI Report

Uh oh!

lavaleri commented May 5, 2020

AWS CodeBuild CI Report

Uh oh!

mattsb42-aws left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

mattsb42-aws May 5, 2020

Choose a reason for hiding this comment

Uh oh!

mattsb42-aws May 5, 2020

Choose a reason for hiding this comment

Uh oh!

robin-aws May 6, 2020

Choose a reason for hiding this comment

Uh oh!

robin-aws May 6, 2020

Choose a reason for hiding this comment

Uh oh!

mattsb42-aws May 6, 2020

Choose a reason for hiding this comment

Uh oh!

robin-aws commented May 6, 2020

Uh oh!

robin-aws commented May 6, 2020

Uh oh!

lavaleri commented May 6, 2020

AWS CodeBuild CI Report

Uh oh!

lavaleri commented May 6, 2020

AWS CodeBuild CI Report

Uh oh!

lavaleri commented May 6, 2020

AWS CodeBuild CI Report

Uh oh!

MatthewBennington commented Apr 24, 2020 •

edited

Loading