Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 4 additions & 0 deletions crates/tower-package/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,9 @@ pub struct Parameter {

#[serde(default)]
pub default: String,

#[serde(default)]
pub hidden: bool,
}

#[derive(Clone, Serialize, Deserialize)]
Expand Down Expand Up @@ -122,6 +125,7 @@ fn get_parameters(towerfile: &Towerfile) -> Vec<Parameter> {
name: p.name.clone(),
description: Some(p.description.clone()),
default: p.default.clone(),
hidden: p.hidden,
});
}
parameters
Expand Down
50 changes: 49 additions & 1 deletion crates/tower-package/tests/package_test.rs
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ use tokio_stream::*;

use config::Towerfile;
use tokio_tar::Archive;
use tower_package::{Manifest, Package, PackageSpec};
use tower_package::{Manifest, Package, PackageSpec, Parameter};
use tower_telemetry::debug;

macro_rules! make_path {
Expand Down Expand Up @@ -385,6 +385,54 @@ async fn building_package_spec_from_towerfile() {
assert_eq!(spec.schedule, Some("0 0 * * *".to_string()));
}

#[tokio::test]
async fn it_includes_hidden_parameters_in_manifest() {
let tmp_dir = TmpDir::new("hidden-params")
.await
.expect("Failed to create temp dir");
create_test_file(tmp_dir.to_path_buf(), "Towerfile", "").await;
create_test_file(tmp_dir.to_path_buf(), "main.py", "print('Hello, world!')").await;

let spec = PackageSpec {
invoke: "main.py".to_string(),
base_dir: tmp_dir.to_path_buf(),
towerfile_path: tmp_dir.to_path_buf().join("Towerfile").to_path_buf(),
file_globs: vec!["*.py".to_string()],
parameters: vec![
Parameter {
name: "visible_param".to_string(),
description: Some("A visible parameter".to_string()),
default: "".to_string(),
hidden: false,
},
Parameter {
name: "hidden_param".to_string(),
description: Some("A hidden parameter".to_string()),
default: "secret".to_string(),
hidden: true,
},
],
schedule: None,
import_paths: vec![],
};

let package = Package::build(spec).await.expect("Failed to build package");
let files = read_package_files(package).await;

let manifest = Manifest::from_json(files.get("MANIFEST").unwrap())
.await
.expect("Manifest was not valid JSON");

assert_eq!(manifest.parameters.len(), 2);

let visible = manifest.parameters.iter().find(|p| p.name == "visible_param").unwrap();
assert!(!visible.hidden, "visible_param should not be hidden");

let hidden = manifest.parameters.iter().find(|p| p.name == "hidden_param").unwrap();
assert!(hidden.hidden, "hidden_param should be hidden");
assert_eq!(hidden.default, "secret");
}

// read_package_files reads the contents of a given package and returns a map of the file paths to
// their contents as a collection of strings. Not useful for anything except for testing purposes.
async fn read_package_files(package: Package) -> HashMap<String, String> {
Expand Down