Skip to content
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

feat: add support to run pre/post scripts #1673

Merged
merged 25 commits into from
Oct 18, 2024
+997 −58
Merged

feat: add support to run pre/post scripts #1673

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
25 commits
Select commit Hold shift + click to select a range
9ea3758
chore(rust): add "strum" as dependency
imobachgs Oct 14, 2024
3af6a9b
feat(rust): add a simple API to register and run scripts
imobachgs Oct 10, 2024
93b6623
feat(ruby): run post-installation scripts
imobachgs Oct 14, 2024
ed8f7ec
feat(ruby): copy scripts artifacts
imobachgs Oct 16, 2024
78b6d1a
feat(rust): validate the script section
imobachgs Oct 16, 2024
3915aa5
feat(rust): improve scripts logging
imobachgs Oct 16, 2024
1c6e59b
fix(docs): fix Script::run documentation
imobachgs Oct 16, 2024
8c5d350
fix(rust): remove old scripts when importing
imobachgs Oct 16, 2024
46deeb5
fix(rust): do not export empty/missing values in scripts
imobachgs Oct 16, 2024
b7c35c1
doc: update changes files
imobachgs Oct 16, 2024
52b2fd8
fix(ruby): fix scripts client
imobachgs Oct 17, 2024
29be17d
refactor(rust): improve scripts representation
imobachgs Oct 18, 2024
b1d5358
fix(rust): add missing 'use'
imobachgs Oct 18, 2024
bbc5614
refactor(rust): implement From trait for ScriptConfig
imobachgs Oct 18, 2024
7252bee
fix(rust): fix scripts tests
imobachgs Oct 18, 2024
73f830f
fix(rust): postpone running pre-scripts
imobachgs Oct 18, 2024
55a6455
fix(ruby): copy scripts to /var/log/agama-installation
imobachgs Oct 18, 2024
820edd5
refactor(rust): remove unused function
imobachgs Oct 18, 2024
bc8ba0f
docs(rust): minor documentation fixes
imobachgs Oct 18, 2024
f7f2318
fix(rust): do not tag ScriptSource in JSON
imobachgs Oct 18, 2024
1ebaab2
Revert "fix(rust): postpone running pre-scripts"
imobachgs Oct 18, 2024
7e4131a
fix(rust): run pre-scripts before selecting the product
imobachgs Oct 18, 2024
afacb84
Merge branch 'master' into auto-scripts
imobachgs Oct 18, 2024
0da989f
Merge branch 'master' into auto-scripts
imobachgs Oct 18, 2024
1322ca9
chore(rust): add a TODO about running pre-scripts
imobachgs Oct 18, 2024
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
25 changes: 24 additions & 1 deletion rust/Cargo.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions rust/agama-lib/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ curl = { version = "0.4.47", features = ["protocol-ftp"] }
jsonwebtoken = "9.3.0"
chrono = { version = "0.4.38", default-features = false, features = ["now", "std", "alloc", "clock"] }
home = "0.5.9"
strum = { version = "0.26.3", features = ["derive"] }

[dev-dependencies]
httpmock = "0.7.0"
Expand Down
143 changes: 89 additions & 54 deletions rust/agama-lib/share/profile.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,9 +54,7 @@
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"id"
],
"required": ["id"],
"properties": {
"id": {
"title": "Connection ID",
Expand All @@ -79,22 +77,12 @@
"method4": {
"title": "IPv4 configuration method",
"type": "string",
"enum": [
"auto",
"manual",
"link-local",
"disabled"
]
"enum": ["auto", "manual", "link-local", "disabled"]
},
"method6": {
"title": "IPv6 configuration method",
"type": "string",
"enum": [
"auto",
"manual",
"link-local",
"disabled"
]
"enum": ["auto", "manual", "link-local", "disabled"]
},
"gateway4": {
"title": "Connection gateway address",
Expand Down Expand Up @@ -162,12 +150,7 @@
"mode": {
"title": "Wireless network mode",
"type": "string",
"enum": [
"infrastructure",
"adhoc",
"mesh",
"ap"
]
"enum": ["infrastructure", "adhoc", "mesh", "ap"]
},
"hidden": {
"title": "Indicates that the wireless network is not broadcasting its SSID",
Expand All @@ -176,15 +159,12 @@
"band": {
"title": "Frequency band of the wireless network",
"type": "string",
"enum": [
"a",
"bg"
]
"enum": ["a", "bg"]
},
"channel": {
"title": "Wireless channel of the wireless network",
"type": "integer",
"minimum" : 0
"minimum": 0
},
"bssid": {
"title": "Only allow connection to this mac address",
Expand All @@ -195,34 +175,23 @@
"items": {
"title": "A list of group/broadcast encryption algorithms",
"type": "string",
"enum": [
"wep40",
"wep104",
"tkip",
"ccmp"
]
"enum": ["wep40", "wep104", "tkip", "ccmp"]
}
},
"pairwiseAlgorithms": {
"type": "array",
"items": {
"title": "A list of pairwise encryption algorithms",
"type": "string",
"enum": [
"tkip",
"ccmp"
]
"enum": ["tkip", "ccmp"]
}
},
"wpaProtocolVersions": {
"type": "array",
"items": {
"title": "A list of allowed WPA protocol versions",
"type": "string",
"enum": [
"wpa",
"rsn"
]
"enum": ["wpa", "rsn"]
}
},
"pmf": {
Expand Down Expand Up @@ -369,10 +338,7 @@
"peapVersion": {
"title": "Which PEAP version is used when PEAP is set as the EAP method in the 'eap' property",
"type": "string",
"enum": [
"0",
"1"
]
"enum": ["0", "1"]
},
"peapLabel": {
"title": "Force the use of the new PEAP label during key derivation",
Expand Down Expand Up @@ -406,11 +372,7 @@
"examples": ["nots3cr3t"]
}
},
"required": [
"fullName",
"userName",
"password"
]
"required": ["fullName", "userName", "password"]
},
"root": {
"title": "Root authentication settings",
Expand Down Expand Up @@ -906,7 +868,7 @@
"description": "Name of a disk device.",
"type": "string",
"examples": ["/dev/vda"]
}
}
}
},
{
Expand Down Expand Up @@ -967,6 +929,30 @@
"items": {
"type": "object"
}
},
"scripts": {
"title": "User-defined installation scripts",
"description": "User-defined scripts to run at different points of the installation",
"type": "object",
"additionalProperties": false,
"properties": {
"pre": {
"title": "Pre-installation scripts",
"description": "User-defined scripts to run before the installation starts",
Copy link
Contributor

@lslezak lslezak Oct 17, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

Um, when exactly? Nothing done yet?

I mean later we might add a "post-partitioning" script so it should be clean whether at this point something is already done by Agama or the system has not been touched yet.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Before the post-partitioning. I can improve the description.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

They were expected to be used to modify the profile, but I am not sure whether we should implement that behavior. Or perhaps to activate some hardware.

"type": "array",
"items": {
"$ref": "#/$defs/script"
}
},
"post": {
"title": "Post-installation scripts",
"description": "User-defined scripts to run after the installation finishes",
"type": "array",
"items": {
"$ref": "#/$defs/script"
}
}
}
}
},
"$defs": {
Expand Down Expand Up @@ -1013,7 +999,12 @@
},
"minItems": 1,
"maxItems": 2,
"examples": [[1024, "current"], ["1 GiB", "5 GiB"], [1024, "2 GiB"], ["2 GiB"]]
"examples": [
[1024, "current"],
["1 GiB", "5 GiB"],
[1024, "2 GiB"],
["2 GiB"]
]
},
{
"title": "Size range",
Expand Down Expand Up @@ -1206,8 +1197,22 @@
{
"title": "File system type",
"enum": [
"bcachefs", "btrfs", "exfat", "ext2", "ext3", "ext4", "f2fs", "jfs",
"nfs", "nilfs2", "ntfs", "reiserfs", "swap", "tmpfs", "vfat", "xfs"
"bcachefs",
"btrfs",
"exfat",
"ext2",
"ext3",
"ext4",
"f2fs",
"jfs",
"nfs",
"nilfs2",
"ntfs",
"reiserfs",
"swap",
"tmpfs",
"vfat",
"xfs"
]
},
{
Expand Down Expand Up @@ -1330,7 +1335,15 @@
},
"id": {
"title": "Partition ID",
"enum": ["linux", "swap", "lvm", "raid", "esp", "prep", "bios_boot"]
"enum": [
"linux",
"swap",
"lvm",
"raid",
"esp",
"prep",
"bios_boot"
]
},
"size": {
"title": "Partition size",
Expand Down Expand Up @@ -1394,6 +1407,28 @@
"lvStripeSize": {
"title": "Stripe size",
"$ref": "#/$defs/sizeValue"
},
"script": {
"title": "User-defined installation script",
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"description": "Script name, to be used as file name",
"type": "string"
},
"body": {
"title": "Script content",
"description": "Script content, starting with the shebang",
"type": "string"
},
"url": {
"title": "Script URL",
"description": "URL to fetch the script from"
}
},
"required": ["name"],
"oneOf": [{ "required": ["body"] }, { "required": ["url"] }]
}
}
}
4 changes: 3 additions & 1 deletion rust/agama-lib/src/install_settings.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
//! This module implements the mechanisms to load and store the installation settings.
use crate::{
localization::LocalizationSettings, network::NetworkSettings, product::ProductSettings,
software::SoftwareSettings, users::UserSettings,
scripts::ScriptsConfig, software::SoftwareSettings, users::UserSettings,
};
use serde::{Deserialize, Serialize};
use serde_json::value::RawValue;
Expand Down Expand Up @@ -55,6 +55,8 @@ pub struct InstallSettings {
pub network: Option<NetworkSettings>,
#[serde(default)]
pub localization: Option<LocalizationSettings>,
#[serde(default)]
pub scripts: Option<ScriptsConfig>,
}

impl InstallSettings {
Expand Down
1 change: 1 addition & 0 deletions rust/agama-lib/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,7 @@ pub mod proxies;
mod store;
pub use store::Store;
pub mod questions;
pub mod scripts;
pub mod transfer;
use crate::error::ServiceError;
use reqwest::{header, Client};
Expand Down
32 changes: 32 additions & 0 deletions rust/agama-lib/src/scripts.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
// Copyright (c) [2024] SUSE LLC
//
// All Rights Reserved.
//
// This program is free software; you can redistribute it and/or modify it
// under the terms of the GNU General Public License as published by the Free
// Software Foundation; either version 2 of the License, or (at your option)
// any later version.
//
// This program is distributed in the hope that it will be useful, but WITHOUT
// ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
// FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
// more details.
//
// You should have received a copy of the GNU General Public License along
// with this program; if not, contact SUSE LLC.
//
// To contact SUSE LLC about this file by physical or electronic mail, you may
// find current contact information at www.suse.com.

//! Implements support for handling the user-defined scripts.

mod client;
mod error;
mod model;
mod settings;
mod store;

pub use error::ScriptError;
pub use model::*;
pub use settings::*;
pub use store::ScriptsStore;
Loading
Loading