Allow passing through environment variables #91

kamalmarhubi · 2017-04-18T03:14:30Z

This adapts @dflemstr's work in #77, removing the whitelist_all functionality as requested in review.

fixes #76
closes #77

kamalmarhubi · 2017-04-18T03:15:11Z

@japaric please critique the configuration UX (location in toml file). I'm happy to change it.

Susurrus · 2017-04-18T03:17:57Z

@kamalmarhubi Comments in #77 also suggested an addition to the README describing the new variables.

Susurrus · 2017-04-18T05:09:44Z

Having used this in testing where I think the whitelist functionality is working correctly, it'd be helpful if during the CI run the specific whitelisted variables and their values were output to stdout. This would make it clear that a) the values got passed through and b) they're the right values.

japaric · 2017-04-19T17:27:11Z

@kamalmarhubi Looks good to me. I'm wondering if we should also have a target.$T.env.whitelist option for target specific variables but that can be added later if needed. Oh, and could you document this feature in the README?

@Susurrus perhaps we could print the env vars to stdout/stderr if the -v (verbose) flag is used.

Susurrus · 2017-04-19T17:36:21Z

@japaric Yeah, I think that would be useful. I'd be fine deferring that to a later PR however in the interest of getting this released.

kamalmarhubi · 2017-04-19T18:13:34Z

I should be able to do this in the next day or so if that timeline is ok. Otherwise happy to make a follow-up PR.

japaric · 2017-04-19T21:08:38Z

I should be able to do this in the next day or so if that timeline is ok.

That'd be fine. Thanks!

kamalmarhubi · 2017-04-20T02:10:17Z

@japaric could you take a look? I'm unable to test it right now as I'm on a restricted network and downloading docker images isn't an easy option.

Also, I'm not super happy with calling this env.whitelist. I'd think something like pass_through or passthrough would be better, but I'm terrible at names.

Susurrus · 2017-04-20T02:27:23Z

README.md

+### Passing environment variables into the build environemnt
+
+By default, `cross` does not pass any environment variables into the build
+environment from the calling shell. Sometimes this is really useful, for


Minor nitpick, but "this" on this line seems to refer to the fact that cross doesn't pass through environment variables by default when I think you want it to mean the opposite. Maybe instead say "This is chosen as a safe default as most use cases will not want the calling environment leaking into the inner execution environment. But in the instances that you do want to pass through environment variables, this can be done through the use of a whitelist."

I agree with @Susurrus here.

Also, given what came up in japaric/trust#73, I suggest it also be made clear that Mac doesn't use docker and so all environment variables are automatically "passed through" and this whitelist is only used for docker-targets (currently just Linux).

Susurrus · 2017-04-20T02:29:35Z

README.md

+```toml
+[build.env]
+whitelist = [
+    "TRAVIS",


#74 specifically talks about RUST_BACKTRACE. Maybe add that here as well as a hint to users that that might be useful?

Susurrus · 2017-04-20T02:31:19Z

@kamalmarhubi I slilghtly prefer passthrough instead of env_whitelist, but I don't have a strong opinion either way.

japaric · 2017-04-20T18:18:38Z

I too think that passthrough fits better.

@kamalmarhubi Do you think you could add a test for this? Perhaps create a library crate that has a unit test that checks for the presence of some env variable, set that var on the host, place a Cross.toml in that crate and then run cross test on the targets that support testing.

Susurrus · 2017-04-24T18:26:37Z

@kamalmarhubi just wanted to ping you on finishing this up. Do you have some time soon here to wrap up this PR?

kamalmarhubi · 2017-04-28T15:31:53Z

I'm sorry for the delay on this. It's easiest for me to work on non-work stuff at the weekends. I'll get to it this weekend!

Susurrus · 2017-05-01T15:30:40Z

Any updates on this @kamalmarhubi?

kamalmarhubi · 2017-05-03T04:44:09Z

I'm having a bit of trouble testing this, as I can't get cross to run at all. I get this error, seemingly with whichever target I use. @japaric any idea what's up?

error: couldn't execute `"rustc" "--print" "target-list"`
caused by: No such file or directory (os error 2)

Susurrus · 2017-05-03T04:45:48Z

I can try to reproduce on my end, what's your test environment?

kamalmarhubi · 2017-05-03T14:11:50Z

Oh I think I see the issue: to use docker I have to be root, but rust and rustup are installed in my home directory.

kamalmarhubi · 2017-05-03T14:28:42Z

Temporarily added myself to the docker group, and it's working. I'll have to test in the evening though. Work beckons!

kamalmarhubi · 2017-06-06T05:25:11Z

Apologies for letting this languish. I've rebased and pushed up stuff addressing the review comments. I have tests in progress but not ready to push.

Susurrus

Otherwise this LGTM.

Susurrus · 2017-06-06T12:11:22Z

src/main.rs

@@ -461,6 +461,46 @@ impl Toml {
            Ok(None)
        }
    }
+
+    /// Returns the list of environment variables to pass through for `target`,
+    /// including variables sepcified under `build` and under `target`.


Misspelled specified.

Eep, fixed!

kamalmarhubi · 2017-06-06T13:52:30Z

@japaric can you take a look and let me know if you need any changes? Also, let me know if I should try to wrap up the tests or if it can be merged as is.

japaric · 2017-06-10T03:03:13Z

Thanks for updating this, @kamalmarhubi. It looks good to me. Let's land it.

@homunkulus r+

homunkulus · 2017-06-10T03:03:13Z

📌 Commit 40a3f1c has been approved by japaric

homunkulus · 2017-06-10T03:03:16Z

⌛ Testing commit 40a3f1c with merge 40a3f1c...

homunkulus · 2017-06-10T03:30:51Z

💔 Test failed - status-travis

kamalmarhubi · 2017-06-10T03:46:26Z

I'll looking into the failure in a couple hours.

This addresses comments on cross-rs#77.

Add support for environment variables to be specified in `Cross.toml` under the `target.<triple>.env.whitelist` key.

Use nested matching to make it easier to see what's going on.

- rename `whitelist` to `passthrough` - reword description of feature in readme - add `RUST_BACKTRACE` to the example in readme

kamalmarhubi · 2017-06-10T08:53:16Z

Pushed a build fix, should be good to try again.

japaric · 2017-06-10T17:37:05Z

@homunkulus r+

homunkulus · 2017-06-10T17:37:06Z

📌 Commit 280917f has been approved by japaric

homunkulus · 2017-06-10T17:37:08Z

⌛ Testing commit 280917f with merge 280917f...

homunkulus · 2017-06-10T18:38:32Z

☀️ Test successful - status-travis
Approved by: japaric
Pushing 280917f to master...

Susurrus · 2017-06-11T00:48:02Z

Awesome work guys, thanks!

kamalmarhubi mentioned this pull request Apr 18, 2017

Skip failing tests for Linux/MIPS/PowerPC nix-rust/nix#590

Merged

Susurrus mentioned this pull request Apr 19, 2017

Expose 'trust_ci' as a feature flag under CI japaric/trust#73

Open

kamalmarhubi force-pushed the env-whitelist branch from 2515454 to 367e736 Compare April 20, 2017 02:19

Susurrus reviewed Apr 20, 2017

View reviewed changes

kamalmarhubi force-pushed the env-whitelist branch from 367e736 to e50b7e2 Compare June 6, 2017 05:25

Susurrus suggested changes Jun 6, 2017

View reviewed changes

dflemstr and others added 8 commits June 10, 2017 04:52

Add configuration support for env var whitelisting

e9c42c0

Forward whitelisted env vars to docker

f1703b5

Remove whitelist_all

b2b5a09

This addresses comments on cross-rs#77.

Support target-specific whitelisted environment variables

9a1a91f

Add support for environment variables to be specified in `Cross.toml` under the `target.<triple>.env.whitelist` key.

Document how to pass environemnt variables through

20d934b

Refactor Toml::build_env_whitelist

8785969

Use nested matching to make it easier to see what's going on.

Address review comments

63144fd

- rename `whitelist` to `passthrough` - reword description of feature in readme - add `RUST_BACKTRACE` to the example in readme

Fix missing rename and a typo

280917f

kamalmarhubi force-pushed the env-whitelist branch from 40a3f1c to 280917f Compare June 10, 2017 08:52

homunkulus merged commit 280917f into cross-rs:master Jun 10, 2017

Susurrus mentioned this pull request Jun 11, 2017

Cross doesn't have a nice way to set RUST_BACKTRACE #74

Closed

Allow passing through environment variables #91

Allow passing through environment variables #91

Conversation

kamalmarhubi commented Apr 18, 2017 • edited Loading

kamalmarhubi commented Apr 18, 2017

Susurrus commented Apr 18, 2017

Susurrus commented Apr 18, 2017

japaric commented Apr 19, 2017

Susurrus commented Apr 19, 2017

kamalmarhubi commented Apr 19, 2017

japaric commented Apr 19, 2017

kamalmarhubi commented Apr 20, 2017

Susurrus Apr 20, 2017

Choose a reason for hiding this comment

japaric Apr 20, 2017

Choose a reason for hiding this comment

Susurrus Apr 20, 2017

Choose a reason for hiding this comment

Susurrus Apr 20, 2017

Choose a reason for hiding this comment

Susurrus commented Apr 20, 2017

japaric commented Apr 20, 2017

Susurrus commented Apr 24, 2017

kamalmarhubi commented Apr 28, 2017

Susurrus commented May 1, 2017

kamalmarhubi commented May 3, 2017

Susurrus commented May 3, 2017

kamalmarhubi commented May 3, 2017

kamalmarhubi commented May 3, 2017

kamalmarhubi commented Jun 6, 2017

Susurrus left a comment

Choose a reason for hiding this comment

Susurrus Jun 6, 2017

Choose a reason for hiding this comment

kamalmarhubi Jun 6, 2017

Choose a reason for hiding this comment

kamalmarhubi commented Jun 6, 2017

japaric commented Jun 10, 2017

homunkulus commented Jun 10, 2017

homunkulus commented Jun 10, 2017

homunkulus commented Jun 10, 2017

kamalmarhubi commented Jun 10, 2017

kamalmarhubi commented Jun 10, 2017

japaric commented Jun 10, 2017

homunkulus commented Jun 10, 2017

homunkulus commented Jun 10, 2017

homunkulus commented Jun 10, 2017

Susurrus commented Jun 11, 2017

kamalmarhubi commented Apr 18, 2017 •

edited

Loading