Cargo-frc project generation and toolchain installation #92

grebneerg · 2020-01-03T06:23:15Z

This PR addresses #87 and #82.

This has only been tested on Manjaro Linux.

Adds cargo frc init <team number> and cargo frc new <name> <team number> for creating boilerplate sample projects.
Adds cargo frc toolchain list to list available toolchains and their installation status (currently 2020 and 2019 are supported)
Adds cargo frc toolchain install <year> to install the latest available toolchain release for the given year in the standard ~/wpilib/$YEAR.
- This will recognize and use preexisting wpilib installs,.
- No uninstall command is present in order to prevent preexisting wpilib installs from being broken.
Adds build command that automatically uses the correct target, linker, and other rustflags to avoid the need for users to mess with .cargo/config
- Can be called directly as cargo frc build --year <year>. Will default to current year (2020) regardless of installation status.
- Also now called by the deploy command, which also has a --year flag that defaults to the current year. This does prevent the use of cargo frc deploy with toolchains not installed by cargo frc, which could potentially be solved by a --no-build flag of some sort requiring a separate build step.

Logical next steps could include making the wpilib install location configurable and adding custom toolchain support.

…n for arm-unknown-linux-gnueabi

…with

…ssues

auscompgeek

Can be called directly as cargo frc build --year <year>. Will default to current year (2020) regardless of installation status.

I think it'd be better to have the year in the frc metadata instead. You'd need to update the dependencies anyway…

We should also set the other relevant environment variables so that things like the cc crate will pick up the toolchain.

auscompgeek · 2020-01-03T09:51:42Z

cargo-frc/src/init.rs

+        .open(path.join("src/main.rs"))
+        .map_err(str_map("Could not open src/main.rs"))?;
+
+    write!(main, "{}", DIGITAL_OUT_ROBOT).map_err(str_map("Could not write to src/main.rs"))?;


Shouldn't we write the timed robot template instead?

I was considering having this selectable via a flag.

Seems like a sensible thing to do. It should probably default to the timed robot template though.

cargo-frc/src/build.rs

auscompgeek · 2020-01-03T09:54:06Z

cargo-frc/src/toolchain.rs

+        //.ok_or("Can't determine home directory".to_owned())
+    }
+
+    pub const TOOLCHAIN_URL_2019: &str = "https://github.com/wpilibsuite/toolchain-builder/releases/download/v2019-3/FRC-2019-Linux-Toolchain-6.3.0.tar.gz";


The official install location for the toolchain changed for this year. I don't think it's worth trying to support the 2019 toolchain.

Thanks, I missed that in the docs. I agree that it isn't necessary to support 2019, but it is useful to test multi-version support.

auscompgeek · 2020-01-03T09:55:00Z

cargo-frc/src/toolchain.rs

+    }
+
+    const TOOLCHAIN_URL_2019: &str = "https://github.com/wpilibsuite/toolchain-builder/releases/download/v2019-3/FRC-2019-Mac-Toolchain-6.3.0.tar.gz";
+    const TOOLCHAIN_URL_2020: &str = "https://github.com/wpilibsuite/roborio-toolchain/releases/download/v2020-2/FRC-2020-Mac-Toolchain-7.3.0.tar.gz";


This gets very repetitive… wouldn't it be sensible to build the URL from its components?

It might be. I went with just directly including the URLs because the toolchain download location has changed twice in the past two years. Building from components would make it easier to install specific versions, or let the user override the version if a newer version is released midseason without needing to update cargo-frc itself. We could potentially even query the github api to see what releases are available, but I'm not sure if that is necessary. I'll think about this some more.

I don't expect the toolchain repo to change location again.

auscompgeek · 2020-01-03T09:55:13Z

cargo-frc/src/toolchain.rs

+    if !Command::new("sh")
+        .arg("-c")
+        .arg(format!(
+            "wget -c {} -O - | tar -xz -C {} --strip-components=1",


I agree, but tar needs to be called no matter what so it seemed worthwhile to use wget to make downloading more convenient. The only thing I really don't like Is the amount of output from wget, but I just found a way to display a progress bar without everything else, so I'll change to that.

Surely there's a tar crate?

There is, but it does tar and nothing else, and requires some extra work to replicate --strip-components=1. Downloading and installing without using sh would require adding reqwest (which could also bring async into the equation), flate2, and tar. Since cargo-frc already heavily relies on calling unix commands instead of using libraries, I figured this would be a very convenient alternative. Do you think it's very important or advantageous to change to use these libraries?

something something Windows

cargo-frc/src/toolchain.rs

grebneerg

Can be called directly as cargo frc build --year <year>. Will default to current year (2020) regardless of installation status.

I think it'd be better to have the year in the frc metadata instead. You'd need to update the dependencies anyway…

We should also set the other relevant environment variables so that things like the cc crate will pick up the toolchain.

That's a good idea. I'll leave the year flag, but have it fall back to the metadata. Are there other variable besides CC that you know of that should be set? I notice that both rustc and cc have ar flags/vars, but I'm not sure if that is important.

auscompgeek · 2020-01-04T11:57:56Z

Looking closer at the cc crate, it looks like we actually want to set $CROSS_COMPILE to arm-frc2019-linux-gnueabi-. I don't think we need to set $CC if we set this.

grebneerg · 2020-01-05T04:12:42Z

I don't see anything about $CROSS_COMPILE anywhere in the docs but I've set CC_arm-unknown-linux-gnueabi which should do what we want. Do we just not care about ar?

auscompgeek · 2020-01-05T05:07:49Z

Archives are always the same format regardless of architecture.

cargo-frc/src/build.rs

auscompgeek · 2020-01-06T02:54:59Z

cargo-frc/src/deploy.rs

@@ -181,7 +181,7 @@ fn ssh<T: AsRef<OsStr>>(target_address: &T, command: &str) -> Result<(), String>
    Ok(())
 }

-const DEPLOY_TARGET_TRIPLE: &str = "arm-unknown-linux-gnueabi";
+const DEPLOY_TARGET_TRIPLE: &str = crate::build::ROBORIO_TARGET_TRIPLE;


Maybe we should move this up a module.

… variants

auscompgeek · 2020-08-31T07:50:06Z

Hey @grebneerg, I'd like to get this in, and plan to use it in CI as well. Any chance you could get this updated?

grebneerg · 2020-08-31T15:37:10Z

Yeah definitely. I got a bit distracted by mentoring my old team when build season started, and then got pretty busy with classes, but I'll try to spend some time this week finishing this up.

…rst-rust-competition into cargo-frc-init

auscompgeek · 2021-03-19T10:14:24Z

cargo-frc/src/config.rs

@@ -91,11 +93,21 @@ pub fn get_config() -> Result<FrcConfig, String> {
        error!("Neither a team number or rio address was specified.");
    };

+    debug!("year val: {:?}", frc.get("year"));


Did you mean to keep this here?

auscompgeek

Since it's 2021, might as well add support for grabbing the 2021 toolchain.

auscompgeek · 2022-04-23T12:20:03Z

cargo-frc/src/config.rs

+        .get("year")
+        .and_then(|v| v.as_u64())
+        .map(|i| i.to_string())
+        .and_then(|s| Toolchain::from_year(s.as_str()));


Instead of converting an integer to a string then effectively back, maybe from_year should take an integer instead.

grebneerg added 16 commits December 22, 2019 10:13

Fix typo in command description

550b840

Initializing cargo project with wpilib dependency

0ad7139

Added example code in generated main.rs and new command

bb944b7

cargo-frc: Creating project-local .cargo/config to enforce compilatio…

f064723

…n for arm-unknown-linux-gnueabi

cargo-frc: Added doc comments

4622996

cargo-frc: Installing 2020 toolchain

bd83b94

cargo-frc: Add build command to handle target selection

c47845b

cargo-frc: Add build command to handle target selection

2b5bf1c

cargo-frc: Allow user to specify which toolchain to install or build …

d3c5f8b

…with

cargo-frc: Specify binary and dev/release in build

be43dd9

cargo-frc: Configure appropriate metadata in new projects

0f9c607

cargo-frc: Use new build function in deploy

d5233cc

Merge branch 'master' into cargo-frc-init

fa2c603

cargo-frc: Cleaning up after failed installations to prevent future i…

3928614

…ssues

cargo-frc: add toolchain list command

e6d9af2

Run rustfmt

6c97e36

auscompgeek requested changes Jan 3, 2020

View reviewed changes

grebneerg commented Jan 3, 2020

View reviewed changes

grebneerg added 2 commits January 4, 2020 22:46

cargo_frc: Setting proper environment variables while building

8565f94

Run rustfmt and fix clippy warnings

0e1319a

auscompgeek reviewed Jan 5, 2020

View reviewed changes

cargo-frc/src/build.rs Outdated Show resolved Hide resolved

Using constants for build targets

1c9fa02

auscompgeek reviewed Jan 6, 2020

View reviewed changes

cargo-frc: add Toolchain::available() to easily retrieve slice of all…

83224eb

… variants

This was linked to issues Aug 31, 2020

Add a cargo frc init project generator #82

Open

cargo frc build to target roboRIO #87

Open

grebneerg added 3 commits August 31, 2020 12:42

Configurable default toolchain year

c8d70c7

Merge branch 'master' of https://github.com/first-rust-competition/fi…

69ff7e6

…rst-rust-competition into cargo-frc-init

Refactoring and formatting

e19acd8

auscompgeek reviewed Mar 19, 2021

View reviewed changes

auscompgeek mentioned this pull request Mar 19, 2021

Move to GitHub Actions for CI #77

Open

auscompgeek reviewed Mar 19, 2021

View reviewed changes

hybras mentioned this pull request Mar 19, 2021

Replace Travis CI w/ Github Actions #98

Draft

auscompgeek reviewed Apr 23, 2022

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Cargo-frc project generation and toolchain installation #92

Cargo-frc project generation and toolchain installation #92

grebneerg commented Jan 3, 2020

auscompgeek left a comment

auscompgeek Jan 3, 2020

grebneerg Jan 5, 2020

auscompgeek Aug 31, 2020

auscompgeek Jan 3, 2020

grebneerg Jan 5, 2020

auscompgeek Jan 3, 2020

grebneerg Jan 3, 2020

auscompgeek Jan 4, 2020

auscompgeek Jan 3, 2020

grebneerg Jan 3, 2020

auscompgeek Jan 4, 2020

grebneerg Jan 5, 2020

auscompgeek Jan 6, 2020

grebneerg left a comment

auscompgeek commented Jan 4, 2020

grebneerg commented Jan 5, 2020

auscompgeek commented Jan 5, 2020

auscompgeek Jan 6, 2020

auscompgeek commented Aug 31, 2020

grebneerg commented Aug 31, 2020

auscompgeek Mar 19, 2021

auscompgeek left a comment

auscompgeek Apr 23, 2022

Cargo-frc project generation and toolchain installation #92

Are you sure you want to change the base?

Cargo-frc project generation and toolchain installation #92

Conversation

grebneerg commented Jan 3, 2020

auscompgeek left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

grebneerg left a comment

Choose a reason for hiding this comment

auscompgeek commented Jan 4, 2020

grebneerg commented Jan 5, 2020

auscompgeek commented Jan 5, 2020

Choose a reason for hiding this comment

auscompgeek commented Aug 31, 2020

grebneerg commented Aug 31, 2020

Choose a reason for hiding this comment

auscompgeek left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment