Skip to content

Changes to be compatible with crate2nix #143

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

Changes to be compatible with crate2nix #143

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1b6a715
Make changes to become compatible with Crate2Nix
soenkeliebau Feb 14, 2023
b53cd04
rustfmt
soenkeliebau Feb 14, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion rust/operator-binary/build.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,13 @@
use std::path::PathBuf;

fn main() {
built::write_built_file().expect("Failed to acquire build-time information");
let out_dir = PathBuf::from(std::env::var("OUT_DIR").expect("OUT_DIR is required"));
built::write_built_file_with_opts(
// built's env module depends on a whole bunch of variables that crate2nix doesn't provide
// so we grab the specific env variables that we care about out ourselves instead.
Comment on lines +6 to +7
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ohhh. This might make my comments useless. But who knows, maybe it works now?

built::Options::default().set_env(false),
"Cargo.toml".as_ref(),
&out_dir.join("built.rs"),
)
.unwrap();
}
11 changes: 6 additions & 5 deletions rust/operator-binary/src/main.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ mod restart_controller;
use futures::pin_mut;
use stackable_operator::cli::{Command, ProductOperatorRun};

use clap::Parser;
use clap::{crate_description, crate_version, Parser};
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We get this info from built_info. Is there a difference?

use stackable_operator::commons::{
authentication::AuthenticationClass,
s3::{S3Bucket, S3Connection},
Expand All @@ -13,10 +13,11 @@ use stackable_operator::CustomResourceExt;

mod built_info {
include!(concat!(env!("OUT_DIR"), "/built.rs"));
pub const TARGET_PLATFORM: Option<&str> = option_env!("TARGET");
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

built_info seems to already export TARGET. But maybe that's different to what you want here?

See:

}

#[derive(Parser)]
#[clap(about = built_info::PKG_DESCRIPTION, author = stackable_operator::cli::AUTHOR)]
#[clap(about, author)]
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is already done:

commons-operator/rust/operator-binary/src/main.rs

Line 26 in c276cec

#[clap(about, author)]

struct Opts {
#[clap(subcommand)]
cmd: Command,
Expand All @@ -42,10 +43,10 @@ async fn main() -> anyhow::Result<()> {
tracing_target,
);
stackable_operator::utils::print_startup_string(
built_info::PKG_DESCRIPTION,
built_info::PKG_VERSION,
crate_description!(),
crate_version!(),
built_info::GIT_VERSION,
built_info::TARGET,
built_info::TARGET_PLATFORM.unwrap_or("unknown target"),
Comment on lines +46 to +49
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The print_startup_string function is superseded by tracing::info!:

commons-operator/rust/operator-binary/src/main.rs

Lines 58 to 66 in c276cec

tracing::info!(
built_info.pkg_version = built_info::PKG_VERSION,
built_info.git_version = built_info::GIT_VERSION,
built_info.target = built_info::TARGET,
built_info.built_time_utc = built_info::BUILT_TIME_UTC,
built_info.rustc_version = built_info::RUSTC_VERSION,
"Starting {description}",
description = built_info::PKG_DESCRIPTION
);

built_info::BUILT_TIME_UTC,
built_info::RUSTC_VERSION,
);
Expand Down