Move book examples into standalone projects. Include them in book via mdbook preprocessor. #766

mitchmindtree · 2022-02-10T09:53:39Z

Closes #544, follows the example set in #731.

This also adds all examples to the Sway workspace so that we can test both projects under CI. Doing so means the Cargo.lock for the workspace requires an update, but I haven't included it yet to reduce noise in the PR. @adlerjohn shall I add the Cargo.lock changes as a final commit in this PR? Or do you generally update the lock file separately?

TODO

mitchmindtree · 2022-02-10T09:55:05Z

docs/src/getting-started/forc_project.md

@@ -39,7 +31,7 @@ Here are the contents of the only Sway file in the project, and the main entry p
 script;

 fn main() {
-


Woops, my editor's setup to remove trailing whitespace automatically when writing the buffer

mitchmindtree · 2022-02-10T09:56:52Z

examples/hello_world/tests/harness.rs

+
+// Generate Rust bindings from our contract JSON ABI
+// FIXME: Incorrect path, see https://github.com/FuelLabs/fuels-rs/issues/94
+abigen!(MyContract, "./examples/hello_world/my-contract-abi.json");


We might need to resolve FuelLabs/fuels-rs#94 before landing this, as this path might be confusing for newcomers reading through the book.

Related to FuelLabs#544. Follows the example set in FuelLabs#731. Tested with `mdbook serve`. Also adds the `hello_world` and `subcurrency` examples to the Sway workspace so that we can test both projects under CI.

adlerjohn · 2022-02-10T13:57:07Z

If you're going to update the workspace or Manifest file deps, then you can update the lockfile in the same PR. That being said, I'm actually against putting the examples in the workspace because that would modify the lockfile. We had to remove examples from fuel-core and move them to a whole new repo to avoid dependency issues. My preference would be instead to add a new task to the CI pipeline to go into each example sub-directory and test it.

mitchmindtree · 2022-02-10T14:04:28Z

We had to FuelLabs/fuel-core#140 and move them to a whole new repo to avoid dependency issues.

Aghhhhh I see, that makes sense. Things get tricky when you build the thing you use to build things in the same repo 😂

My preference would be instead to add a new task to the CI pipeline to go into each example sub-directory and test it.

Sounds good - I'm in the middle of writing a little rust "script" that runs forc build for each forc project under the examples directory solely for the purpose of running in CI. I'll try modifying it to also run the tests manually for each so we can remove them from the workspace altogether.

examples/build-all-examples/Cargo.toml

Cargo.lock

Cargo.toml

This script walks the examples directory and, for every directory containing a `forc.toml` file, runs `forc build` for that directory. Examples that encounter a failure of some kind have their `stdout` and `stderr` piped through so we can easily identify cause of failure in CI. This also removes the examples from the workspace. Currently unsure whether or not the added CI pass to install `forc` will result in `forc` actually being available on the PATH in the CI worker, but will find out soon. Still need to work out how to run `forc test` for each project without having cargo complain about building within the parent sway workspace.

Currently, it's tricky to get an idea of how many successes/failures there were without combing through the stdout/stderr. This adds a little summary to the end that looks something like this: ``` Build all examples summary: [✓]: /home/mindtree/programming/rust/fuel/sway/examples/fizzbuzz succeeded! [✓]: /home/mindtree/programming/rust/fuel/sway/examples/hello_world succeeded! [x]: /home/mindtree/programming/rust/fuel/sway/examples/wallet_smart_contract failed! [✓]: /home/mindtree/programming/rust/fuel/sway/examples/subcurrency succeeded! 3 successes, 1 failure ```

mitchmindtree · 2022-02-11T02:05:57Z

OK, I think this is just about ready to go!

Testing examples

I think it's best to leave the example testing (i.e. running forc test for each) to a future PR as there are a few issues involved that should be worked through first. I've opened #771 to track this.

wallet_smart_contract failure

Currently the wallet_smart_contract example fails during forc build as storage isn't yet implemented. We could leave this PR up until storage lands (it sounds like its not far off?) or add a hack to ignore this example for now?

adlerjohn · 2022-02-11T02:08:46Z

We could leave this PR up until storage lands (it sounds like its not far off?) or add a hack to ignore this example for now?

I'd say just comment out the offending lines and add a comment to the effect of "storage not yet implement, see this here PR, and here's how it would look if it were implemented." That way all examples at least compile.

This example should be updated after FuelLabs#646 lands.

Currently it takes CI another 7 mins to build and install forc from scratch. This should allow `cargo` to re-use the artifacts it has already built during the sway building and testing steps earlier in the CI job.

mitchmindtree · 2022-02-11T12:50:56Z

Okydoke, I had to comment out a large portion of the wallet example, but I've left a NOTE at the top with a link to the PR. Once this lands I'll open a dedicated issue for updating the wallet example.

sezna

Generally LGTM, left some nits

examples/fizzbuzz/Forc.toml

examples/hello_world/Cargo.toml

examples/hello_world/Forc.toml

examples/wallet_smart_contract/Cargo.toml

examples/wallet_smart_contract/Forc.toml

mitchmindtree · 2022-02-12T00:02:45Z

@sezna good catch, should be addressed now!

mitchmindtree commented Feb 10, 2022

View reviewed changes

Extract hello_world example from the book into a standalone project

db4d278

Related to FuelLabs#544. Follows the example set in FuelLabs#731. Tested with `mdbook serve`. Also adds the `hello_world` and `subcurrency` examples to the Sway workspace so that we can test both projects under CI.

mitchmindtree force-pushed the book-example-extraction branch from 82a5a56 to db4d278 Compare February 10, 2022 09:58

mitchmindtree added 2 commits February 11, 2022 00:31

Fix hello_world example project name in forc manifest

9c4506d

Move fizzbuzz and wallet_smart_contract examples to standalone projects

43b45ac

adlerjohn assigned mitchmindtree Feb 10, 2022

adlerjohn added ci The Sway Book Everything to do with the Sway Book labels Feb 10, 2022

adlerjohn reviewed Feb 10, 2022

View reviewed changes

examples/build-all-examples/Cargo.toml Outdated Show resolved Hide resolved

Cargo.lock Outdated Show resolved Hide resolved

Cargo.toml Show resolved Hide resolved

mitchmindtree force-pushed the book-example-extraction branch from e74a1e3 to 3fd37fa Compare February 11, 2022 00:16

mitchmindtree force-pushed the book-example-extraction branch from 75f7d3f to ee5984a Compare February 11, 2022 00:39

Set build-all-examples script version to 0.0.0

f9ba8c3

mitchmindtree marked this pull request as ready for review February 11, 2022 01:18

mitchmindtree requested a review from sezna as a code owner February 11, 2022 01:18

Exclude examples from workspace, Fix hello_world test harness path

9fb07f4

mitchmindtree added 2 commits February 11, 2022 19:51

Temporarily comment out storage related code in wallet example

4da1bee

This example should be updated after FuelLabs#646 lands.

Install forc with --debug to share build artifacts

e6db124

Currently it takes CI another 7 mins to build and install forc from scratch. This should allow `cargo` to re-use the artifacts it has already built during the sway building and testing steps earlier in the CI job.

mitchmindtree mentioned this pull request Feb 11, 2022

Try splitting the existing CI "build" job into multiple jobs for a potential speedup #772

Closed

sezna suggested changes Feb 11, 2022

View reviewed changes

Change author field in examples from mindtree -> Fuel Labs

542f0a1

adlerjohn approved these changes Feb 12, 2022

View reviewed changes

adlerjohn requested a review from sezna February 13, 2022 23:14

sezna approved these changes Feb 15, 2022

View reviewed changes

mitchmindtree merged commit e10acd6 into FuelLabs:master Feb 15, 2022

mitchmindtree mentioned this pull request Feb 15, 2022

Add --output-directory to forc build and related commands #796

Merged

10 tasks

mitchmindtree deleted the book-example-extraction branch February 15, 2022 12:10

mitchmindtree mentioned this pull request Feb 15, 2022

Add build-all-examples to Cargo.lock #803

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Move book examples into standalone projects. Include them in book via mdbook preprocessor. #766

Move book examples into standalone projects. Include them in book via mdbook preprocessor. #766

mitchmindtree commented Feb 10, 2022 •

edited

Loading

mitchmindtree Feb 10, 2022 •

edited

Loading

mitchmindtree Feb 10, 2022

adlerjohn commented Feb 10, 2022

mitchmindtree commented Feb 10, 2022

mitchmindtree commented Feb 11, 2022

adlerjohn commented Feb 11, 2022

mitchmindtree commented Feb 11, 2022

sezna left a comment

mitchmindtree commented Feb 12, 2022

		@@ -39,7 +31,7 @@ Here are the contents of the only Sway file in the project, and the main entry p
		script;

		fn main() {

Move book examples into standalone projects. Include them in book via mdbook preprocessor. #766

Move book examples into standalone projects. Include them in book via mdbook preprocessor. #766

Conversation

mitchmindtree commented Feb 10, 2022 • edited Loading

TODO

mitchmindtree Feb 10, 2022 • edited Loading

Choose a reason for hiding this comment

mitchmindtree Feb 10, 2022

Choose a reason for hiding this comment

adlerjohn commented Feb 10, 2022

mitchmindtree commented Feb 10, 2022

mitchmindtree commented Feb 11, 2022

adlerjohn commented Feb 11, 2022

mitchmindtree commented Feb 11, 2022

sezna left a comment

Choose a reason for hiding this comment

mitchmindtree commented Feb 12, 2022

mitchmindtree commented Feb 10, 2022 •

edited

Loading

mitchmindtree Feb 10, 2022 •

edited

Loading