wr

A Rust workshop runner

wr is a CLI to drive test-driven workshops written in Rust.
It is designed to be used in conjunction with a workshop repository, which contains a series of exercises to be solved by the workshop participants.

Note
This workshop runner has been developed by Mainmatter to support our hands-on Rust workshops. Check out our landing page if you're looking for Rust consulting or training!

How it works

What I cannot create, I do not understand.

Richard Feynman

A test-driven workshop is structured as a series of exercises.
Each exercise is a Rust project with a set of tests that verify the correctness of the solution.

wr will run the tests for the current exercise and, if they pass, allow you to move on to the next exercise while keeping track of what you have solved so far.

You can see it in action in the rust-telemetry-workshop.

Installation

cargo install workshop-runner

Check that it has been installed correctly:

wr --help

Run

wr

from the top-level folder of a workshop repository to verify your current solutions and move forward in the workshop.

Enjoy!

Folder structure

wr expects the following structure for the workshop repository:

.
├── exercises
│  ├── 00_<collection name>
│  │  ├── 00_<exercise name>
│  │  │  ..
│  │  ├── 0n_<exercise name>
│  │  ..
│  ├── 0n_<collection name>
│  │  ├── 00_<exercise name>
│  │  │  ..
│  │  ├── 0n_<exercise name>

Each xx_<exercise name> folder must be a Rust project with its own Cargo.toml file.

You can choose a different top-level folder name by either passing the --exercises-dir flag when invoking wr or by creating a top-level wr.toml file with the following content:

exercises-dir = "my-top-level-folder"

You can refer to rust-telemetry-workshop as an example.

Welcome to Renovate! This is an onboarding PR to help you understand and configure settings before regular Pull Requests begin.

🚦 To activate Renovate, merge this Pull Request. To disable Renovate, simply close this Pull Request unmerged.

Detected Package Files

Cargo.toml (cargo)

Configuration Summary

Based on the default config's presets, Renovate will:

Start dependency updates only once this onboarding PR is merged
Show all Merge Confidence badges for pull requests.
Enable Renovate Dependency Dashboard creation.
Use semantic commit type fix for dependencies and chore for all others if semantic commits are in use.
Ignore node_modules, bower_components, vendor and various test/tests directories.
Group known monorepo packages together.
Use curated list of recommended non-monorepo package groupings.
Apply crowd-sourced package replacement rules.
Apply crowd-sourced workarounds for known problems with packages.

🔡 Would you like to change the way Renovate is upgrading your dependencies? Simply edit the renovate.json in this branch with your custom config and the list of Pull Requests in the "What to Expect" section below will be updated the next time Renovate runs.

What to Expect

With your current configuration, Renovate will create 6 Pull Requests:

Update Rust crate anyhow to 1.0.75

Schedule: ["at any time"]
Branch name: renovate/anyhow-1.x
Merge into: main
Upgrade anyhow to 1.0.75

Update Rust crate indexmap to 2.0.2

Schedule: ["at any time"]
Branch name: renovate/indexmap-2.x
Merge into: main
Upgrade indexmap to 2.0.2

Update Rust crate regex to 1.9.6

Schedule: ["at any time"]
Branch name: renovate/regex-1.x
Merge into: main
Upgrade regex to 1.9.6

Update Rust crate serde to 1.0.188

Schedule: ["at any time"]
Branch name: renovate/serde-monorepo
Merge into: main
Upgrade serde to 1.0.188

Update Rust crate clap to 4.4.6

Schedule: ["at any time"]
Branch name: renovate/clap-4.x
Merge into: main
Upgrade clap to 4.4.6

Update Rust crate toml to 0.8.2

Schedule: ["at any time"]
Branch name: renovate/toml-0.x
Merge into: main
Upgrade toml to 0.8.2

🚸 Branch creation will be limited to maximum 2 per hour, so it doesn't swamp any CI resources or overwhelm the project. See docs for prhourlylimit for details.

❓ Got questions? Check out Renovate's Docs, particularly the Getting Started section. If you need any further assistance then you can also request help here.

This PR has been generated by Mend Renovate. View repository job log here.

Configure Renovate
Welcome to Renovate! This is an onboarding PR to help you understand and configure settings before regular Pull Requests begin.

🚦 To activate Renovate, merge this Pull Request. To disable Renovate, simply close this Pull Request unmerged.

Detected Package Files

Cargo.toml (cargo)

Configuration Summary

Based on the default config's presets, Renovate will:

Start dependency updates only once this onboarding PR is merged

Show all Merge Confidence badges for pull requests.

Enable Renovate Dependency Dashboard creation.

Use semantic commit type fix for dependencies and chore for all others if semantic commits are in use.

Ignore node_modules, bower_components, vendor and various test/tests directories.

Group known monorepo packages together.

Use curated list of recommended non-monorepo package groupings.

Apply crowd-sourced package replacement rules.

Apply crowd-sourced workarounds for known problems with packages.

🔡 Would you like to change the way Renovate is upgrading your dependencies? Simply edit the renovate.json in this branch with your custom config and the list of Pull Requests in the "What to Expect" section below will be updated the next time Renovate runs.

What to Expect

With your current configuration, Renovate will create 6 Pull Requests:

Update Rust crate anyhow to 1.0.75

Schedule: ["at any time"]

Branch name: renovate/anyhow-1.x

Merge into: main

Upgrade anyhow to 1.0.75

Update Rust crate indexmap to 2.0.2

Schedule: ["at any time"]

Branch name: renovate/indexmap-2.x

Merge into: main

Upgrade indexmap to 2.0.2

Update Rust crate regex to 1.9.6

Schedule: ["at any time"]

Branch name: renovate/regex-1.x

Merge into: main

Upgrade regex to 1.9.6

Update Rust crate serde to 1.0.188

Schedule: ["at any time"]

Branch name: renovate/serde-monorepo

Merge into: main

Upgrade serde to 1.0.188

Update Rust crate clap to 4.4.6

Schedule: ["at any time"]

Branch name: renovate/clap-4.x

Merge into: main

Upgrade clap to 4.4.6

Update Rust crate toml to 0.8.2

Schedule: ["at any time"]

Branch name: renovate/toml-0.x

Merge into: main

Upgrade toml to 0.8.2

🚸 Branch creation will be limited to maximum 2 per hour, so it doesn't swamp any CI resources or overwhelm the project. See docs for prhourlylimit for details.

❓ Got questions? Check out Renovate's Docs, particularly the Getting Started section. If you need any further assistance then you can also request help here.

This PR has been generated by Mend Renovate. View repository job log here.
opened by renovate[bot] 1

A CLI tool to drive test-driven Rust workshops

Related tags

Overview

wr

How it works

Installation

Folder structure

You might also like...

Simple test app based on rust-psp

A tui to test regexes on the rust regex crate

Black-box integration tests for your REST API using the Rust and its test framework

Sanctity is an acronym for rust ansi16 color test utility

Cucumber testing framework for Rust. Fully native, no external test runners or dependencies.

Email test server for development, written in Rust

A Rust command that prettifies the ugly `cargo test` output into a beautiful one.

create and test the style and formatting of text in your terminal applications

Terminal-based typing test.

Comments

Configure Renovate

Detected Package Files

Configuration Summary

What to Expect

Owner

Mainmatter

A commmand line tool for uploading homework coded on the dcloud server onto specific google drive course folders.

Coppers is a custom test harnass for Rust that measures the energy usage of your test suite.

gfold is a CLI-driven application that helps you keep track of multiple Git repositories.

Open-source Rust framework for building event-driven live-trading & backtesting systems

A command driven spotify player

policy-driven signing service

Make data-driven table rendering easy with Dioxus

Holo is a suite of routing protocols designed to support high-scale and automation-driven networks.

A CLI tool to get help with CLI tools 🐙

Rust File Management CLI is a command-line tool written in Rust that provides essential file management functionalities. Whether you're working with files or directories, this tool simplifies common file operations with ease.