dnrops
/
smithy-rs
mirror of https://github.com/smithy-lang/smithy-rs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
365 Commits 258 Branches 125 Tags 172 MiB
Rust 51.6%
Kotlin 44.6%
Smithy 1.8%
Python 0.7%
Shell 0.6%
Other 0.5%
Go to file
John DiSanti 21df7234a6
Include SDK example/test projects in CI and centralize Cargo target directory (#636) 
* Create workspaces for AWS SDK examples and tests and add CI step to verify them

* Centralize the Cargo target directory

* Remove the separate example workspace for now since it conflicts with the generated one

* Fix the rustfmt step

* Fix build path

* Fix mkdir in standalone tests
 		2021-08-09 12:25:40 -07:00
.cargo Include SDK example/test projects in CI and centralize Cargo target directory (#636) 2021-08-09 12:25:40 -07:00
.github Include SDK example/test projects in CI and centralize Cargo target directory (#636) 2021-08-09 12:25:40 -07:00
aws Include SDK example/test projects in CI and centralize Cargo target directory (#636) 2021-08-09 12:25:40 -07:00
codegen Refactor middleware to use new `operation::Response` instead of `http::Response<SdkBody>` (#635) 2021-08-05 17:44:58 -07:00
codegen-test change http checksums to be base64 encoded (#615) 2021-07-28 15:29:02 +00:00
design Refactor middleware to use new `operation::Response` instead of `http::Response<SdkBody>` (#635) 2021-08-05 17:44:58 -07:00
gradle Add pre-commit hooks (#17) 2020-11-04 22:09:00 -05:00
rust-runtime Refactor middleware to use new `operation::Response` instead of `http::Response<SdkBody>` (#635) 2021-08-05 17:44:58 -07:00
.gitignore Sensitive trait (#229) 2021-02-23 23:09:03 +00:00
.pre-commit-config.yaml Update rustfmt hook to run on all files (#348) 2021-04-30 17:33:20 -04:00
CHANGELOG.md Allow the closure passed to `async_provide_credentials_fn` to borrow (#637) 2021-08-09 11:07:31 -07:00
CODE_OF_CONDUCT.md Initial commit 2020-10-28 06:37:45 -07:00
CONTRIBUTING.md master -> main in Contributing.md (#300) 2021-04-14 14:46:50 +00:00
LICENSE Initial commit 2020-10-28 06:37:45 -07:00
NOTICE Initial commit 2020-10-28 06:37:45 -07:00
README.md Fix design docs link 2021-05-22 20:37:40 -04:00
build.gradle.kts Run all tests in the same cargo workspace (#28) 2020-11-17 11:35:30 -05:00
gradle.properties Smithy 1.9/1.10 Upgrade (#618) 2021-07-30 15:25:10 +00:00
gradlew Add gradle files 2020-10-28 11:01:13 -04:00
gradlew.bat Add gradle files 2020-10-28 11:01:13 -04:00
settings.gradle.kts Deserialize Extended S3 Errors (#429) 2021-05-28 12:55:07 -04:00
test.sh Credentials Provider Initial Implementation (#179) 2021-01-28 10:39:05 -05:00

README.md

Smithy Rust status

Smithy code generators for Rust

The nightly SDK build can be found under Actions -> CI (take latest run) -> Artifacts

Design documentation (WIP)

All internal and external interfaces are considered unstable and subject to change without notice.

Setup

  1. ./gradlew will setup gradle for you. JDK 11 is required.
  2. Running tests requires a working Rust installation. See Rust docs for installation instructions on your platform. Minimum supported Rust version is the latest released Rust version, although older versions may work.

Generate an AWS SDK

The generated SDK will be placed in aws/sdk/build/aws-sdk.

./gradlew :aws:sdk:assemble # Generate an SDK. Do not attempt to compile / run tests
./gradlew :aws:sdk:test # Run all the tests
./gradlew :aws:sdk:cargoCheck # only validate that it compiles

Run tests

./test.sh

This will run all the unit tests, codegen example models & Dynamo DB, validate that the generated code compiles, and run any tests targeting the generated code.

Development

For development, pre-commit hooks may be useful. Setup:

brew install pre-commit # (or appropriate for your platform: https://pre-commit.com/)
pre-commit install

Project Layout

  • aws: AWS specific codegen & Rust code (signing, endpoints, customizations, etc.) Common commands:
    • ./gradlew :aws:sdk:assemble: Generate (but do not test / compile etc.) a fresh SDK into sdk/build/aws-sdk
    • ./gradlew :aws:sdk:test: Generate & run all tests for a fresh SDK
    • ./gradlew :aws:sdk:{cargoCheck, cargoTest, cargoDocs, cargoClippy}: Generate & run specified cargo command.
  • codegen: Whitelabel Smithy code generation
  • codegen-test: Smithy protocol test generation & integration tests for Smithy whitelabel code
  • design: Design documentation. See the design/README.md for details about building / viewing.