Merge branch 'feat/s_flag' into dev

This commit is contained in:
Jack Wills
2022-12-05 02:06:09 +00:00
12 changed files with 84 additions and 39 deletions
+11
View File
@@ -1,3 +1,14 @@
### Chores
+ dependencies updated, [e3aa4420cb510df0381e311d37e768937070387a]
+ docker-compose alpine bump, [911c6596684db4ccbe7a55aadd6f595a95f89bb0]
+ github workflow use dtolnay/rust-toolchain, [57c18878690477a05d7330112a65d1d58a07901e]
### Features
+ Clicking a header now toggles between Ascending -> Descending -> Default/no order. Use create_time as the default order - maybe add created column in future version, closes #18, [cf14ba498987db587c0f5bef8a67cf4113ffcb1e], [d1de291473d8a1028f1936429832d3820d75df54]
+ `-s` flag for showing self when operating in a containerised environment, [c93870e5fbbc7df35c69d32e4460d2104e521e33]
# <a href='https://github.com/mrjackwills/oxker/releases/tag/v0.1.7'>v0.1.7</a> # <a href='https://github.com/mrjackwills/oxker/releases/tag/v0.1.7'>v0.1.7</a>
### 2022-11-13 ### 2022-11-13
+1
View File
@@ -73,6 +73,7 @@ Available command line arguments
|```-r```| show raw logs, by default oxker will remove ANSI formatting (conflicts with -c) | |```-r```| show raw logs, by default oxker will remove ANSI formatting (conflicts with -c) |
|```-c```| attempt to color the logs (conflicts with -r) | |```-c```| attempt to color the logs (conflicts with -r) |
|```-t```| remove timestamps from each log entry | |```-t```| remove timestamps from each log entry |
|```-s```| if running via docker, will show the oxker container |
|```-g```| no tui, basically a pointless debugging mode, for now | |```-g```| no tui, basically a pointless debugging mode, for now |
## Build step ## Build step
+2 -1
View File
@@ -55,5 +55,6 @@ FROM alpine:latest AS runtime
COPY --from=builder /oxker /usr/local/bin COPY --from=builder /oxker /usr/local/bin
COPY ./containerised/start_oxker.sh ./ COPY ./containerised/start_oxker.sh ./
# Run the application, this is used in the application itself, to stop itself show when running from a docker container, so DO NOT EDIT # Run the application
# this is used in the application itself, to stop itself show when running from a docker container, so DO NOT EDIT
ENTRYPOINT [ "./start_oxker.sh"] ENTRYPOINT [ "./start_oxker.sh"]
+7 -4
View File
@@ -8,13 +8,16 @@ FROM alpine:latest AS runtime
COPY ./target/x86_64-unknown-linux-musl/release/oxker /usr/local/bin COPY ./target/x86_64-unknown-linux-musl/release/oxker /usr/local/bin
COPY ./containerised/start_oxker.sh ./ COPY ./containerised/start_oxker.sh ./
# Run the application, this is used in the application itself, to stop itself show when running from a docker container, so DO NOT EDIT # Run the application
# this is used in the application itself, to stop itself show when running from a docker container, so DO NOT EDIT
ENTRYPOINT [ "./start_oxker.sh"] ENTRYPOINT [ "./start_oxker.sh"]
## One liner to build musl program, build docker image, then execute the image ## One liner to build musl program, build docker image, then execute the image
# cargo build --release --target x86_64-unknown-linux-musl && docker build -t oxker_dev -f containerised/Dockerfile_dev . && docker run --rm -it --volume /var/run/docker.sock:/var/run/docker.sock:ro oxker_dev # cargo build --release --target x86_64-unknown-linux-musl && docker build -t oxker_dev -f containerised/Dockerfile . && docker run --rm -it --volume /var/run/docker.sock:/var/run/docker.sock:ro oxker_dev
# Build production version
# docker build --platform linux/arm/v6 --platform linux/arm64 --platform linux/amd64 -t oxker_dev -f containerised/Dockerfile . && docker run --rm -it --volume /var/run/docker.sock:/var/run/docker.sock:ro oxker_dev
## Buildx command to build musl version for all three platforms, should probably be executed in create_release # Buildx command to build musl version for all three platforms, should probably be executed in create_release
# docker buildx create --use # docker buildx create --use
# docker buildx build --platform linux/arm/v6,linux/arm64,linux/amd64 -t oxker_dev_all -o type=tar,dest=/tmp/oxker_dev_all.tar -f containerised/Dockerfile . # docker buildx build --platform linux/arm/v6,linux/arm64,linux/amd64 -t oxker_dev_all -o type=tar,dest=/tmp/oxker_dev_all.tar -f containerised/Dockerfile .
+3 -3
View File
@@ -104,12 +104,12 @@ update_release_body_and_changelog () {
echo -e "# <a href='${GIT_REPO_URL}/releases/tag/${NEW_TAG_WITH_V}'>${NEW_TAG_WITH_V}</a>\n${DATE_SUBHEADING}${CHANGELOG_ADDITION}$(cat CHANGELOG.md)" > CHANGELOG.md echo -e "# <a href='${GIT_REPO_URL}/releases/tag/${NEW_TAG_WITH_V}'>${NEW_TAG_WITH_V}</a>\n${DATE_SUBHEADING}${CHANGELOG_ADDITION}$(cat CHANGELOG.md)" > CHANGELOG.md
# Update changelog to add links to commits [hex:8](url_with_full_commit) # Update changelog to add links to commits [hex:8](url_with_full_commit)
# "[aaaaaaaaaabbbbbbbbbbccccccccccddddddddd]" -> "[aaaaaaaa](https:/www.../commit/aaaaaaaaaabbbbbbbbbbccccccccccddddddddd)," # "[aaaaaaaaaabbbbbbbbbbccccccccccddddddddd]" -> "[aaaaaaaa](https:/www.../commit/aaaaaaaaaabbbbbbbbbbccccccccccddddddddd)"
sed -i -E "s=(\s)\[([0-9a-f]{8})([0-9a-f]{32})\]= [\2](${GIT_REPO_URL}/commit/\2\3)=g" ./CHANGELOG.md sed -i -E "s=(\s)\[([0-9a-f]{8})([0-9a-f]{32})\]= [\2](${GIT_REPO_URL}/commit/\2\3)=g" ./CHANGELOG.md
# Update changelog to add links to closed issues - comma included! # Update changelog to add links to closed issues - comma included!
# "closes #1," -> "closes [#1](https:/www.../issues/1),"" # "closes #1" -> "closes [#1](https:/www.../issues/1),""
sed -i -r -E "s=closes \#([0-9]+)\,=closes [#\1](${GIT_REPO_URL}/issues/\1),=g" ./CHANGELOG.md sed -i -r -E "s=closes \#([0-9]+)\=closes [#\1](${GIT_REPO_URL}/issues/\1)=g" ./CHANGELOG.md
} }
# update version in cargo.toml, to match selected current version # update version in cargo.toml, to match selected current version
+12 -3
View File
@@ -356,6 +356,7 @@ pub type CpuTuple = (Vec<(f64, f64)>, CpuStats, State);
/// Info for each container /// Info for each container
#[derive(Debug, Clone)] #[derive(Debug, Clone)]
pub struct ContainerItem { pub struct ContainerItem {
pub created: u64,
pub cpu_stats: VecDeque<CpuStats>, pub cpu_stats: VecDeque<CpuStats>,
pub docker_controls: StatefulList<DockerControls>, pub docker_controls: StatefulList<DockerControls>,
pub id: ContainerId, pub id: ContainerId,
@@ -366,19 +367,27 @@ pub struct ContainerItem {
pub mem_stats: VecDeque<ByteStats>, pub mem_stats: VecDeque<ByteStats>,
pub name: String, pub name: String,
pub rx: ByteStats, pub rx: ByteStats,
pub tx: ByteStats,
pub state: State, pub state: State,
pub status: String, pub status: String,
pub tx: ByteStats,
} }
impl ContainerItem { impl ContainerItem {
/// Create a new container item /// Create a new container item
pub fn new(id: ContainerId, status: String, image: String, state: State, name: String) -> Self { pub fn new(
id: ContainerId,
status: String,
image: String,
state: State,
name: String,
created: u64,
) -> Self {
let mut docker_controls = StatefulList::new(DockerControls::gen_vec(state)); let mut docker_controls = StatefulList::new(DockerControls::gen_vec(state));
docker_controls.start(); docker_controls.start();
let mut logs = StatefulList::new(vec![]); let mut logs = StatefulList::new(vec![]);
logs.end(); logs.end();
Self { Self {
created,
cpu_stats: VecDeque::with_capacity(60), cpu_stats: VecDeque::with_capacity(60),
docker_controls, docker_controls,
id, id,
@@ -389,9 +398,9 @@ impl ContainerItem {
mem_stats: VecDeque::with_capacity(60), mem_stats: VecDeque::with_capacity(60),
name, name,
rx: ByteStats::default(), rx: ByteStats::default(),
tx: ByteStats::default(),
state, state,
status, status,
tx: ByteStats::default(),
} }
} }
+20 -9
View File
@@ -11,10 +11,10 @@ pub use container_state::*;
/// Global app_state, stored in an Arc<Mutex> /// Global app_state, stored in an Arc<Mutex>
#[derive(Debug, Clone)] #[derive(Debug, Clone)]
pub struct AppData { pub struct AppData {
args: CliArgs,
error: Option<AppError>, error: Option<AppError>,
logs_parsed: bool, logs_parsed: bool,
sorted_by: Option<(Header, SortedOrder)>, sorted_by: Option<(Header, SortedOrder)>,
pub args: CliArgs,
pub containers: StatefulList<ContainerItem>, pub containers: StatefulList<ContainerItem>,
} }
@@ -171,19 +171,20 @@ impl AppData {
output output
} }
/// Sort the containers vec, based on a heading, either ascending or descending /// Sort the containers vec, based on a heading, either ascending or descending,
pub fn sort_containers(&mut self) { /// If not sort set, then sort by created time
if let Some((head, ord)) = self.sorted_by.as_ref() { fn sort_containers(&mut self) {
if let Some((head, ord)) = self.sorted_by {
match head { match head {
Header::State => match ord { Header::State => match ord {
SortedOrder::Desc => self
.containers
.items
.sort_by(|a, b| a.state.order().cmp(&b.state.order())),
SortedOrder::Asc => self SortedOrder::Asc => self
.containers .containers
.items .items
.sort_by(|a, b| b.state.order().cmp(&a.state.order())), .sort_by(|a, b| b.state.order().cmp(&a.state.order())),
SortedOrder::Desc => self
.containers
.items
.sort_by(|a, b| a.state.order().cmp(&b.state.order())),
}, },
Header::Status => match ord { Header::Status => match ord {
SortedOrder::Asc => self SortedOrder::Asc => self
@@ -238,6 +239,10 @@ impl AppData {
SortedOrder::Desc => self.containers.items.sort_by(|a, b| b.tx.cmp(&a.tx)), SortedOrder::Desc => self.containers.items.sort_by(|a, b| b.tx.cmp(&a.tx)),
}, },
} }
} else {
self.containers
.items
.sort_by(|a, b| a.created.cmp(&b.created))
} }
} }
@@ -428,9 +433,13 @@ impl AppData {
pub fn update_containers(&mut self, all_containers: &mut [ContainerSummary]) { pub fn update_containers(&mut self, all_containers: &mut [ContainerSummary]) {
let all_ids = self.get_all_ids(); let all_ids = self.get_all_ids();
// Sort the containes by created, that have a constant order
all_containers.sort_by(|a, b| a.created.cmp(&b.created));
if !all_containers.is_empty() && self.containers.state.selected().is_none() { if !all_containers.is_empty() && self.containers.state.selected().is_none() {
self.containers.start(); self.containers.start();
} }
let now = Self::get_systemtime();
for (index, id) in all_ids.iter().enumerate() { for (index, id) in all_ids.iter().enumerate() {
if !all_containers if !all_containers
@@ -472,6 +481,8 @@ impl AppData {
.map_or(String::new(), std::clone::Clone::clone); .map_or(String::new(), std::clone::Clone::clone);
let id = ContainerId::from(id); let id = ContainerId::from(id);
let created = i.created.map_or(now, |i| u64::try_from(i).unwrap_or(now));
// If container info already in containers Vec, then just update details // If container info already in containers Vec, then just update details
if let Some(item) = self.get_container_by_id(&id) { if let Some(item) = self.get_container_by_id(&id) {
if item.name != name { if item.name != name {
@@ -496,7 +507,7 @@ impl AppData {
}; };
// else container not known, so make new ContainerItem and push into containers Vec // else container not known, so make new ContainerItem and push into containers Vec
} else { } else {
let container = ContainerItem::new(id, status, image, state, name); let container = ContainerItem::new(id, status, image, state, name, created);
self.containers.items.push(container); self.containers.items.push(container);
} }
} }
+13 -11
View File
@@ -51,14 +51,14 @@ impl Binate {
pub struct DockerData { pub struct DockerData {
app_data: Arc<Mutex<AppData>>, app_data: Arc<Mutex<AppData>>,
args: CliArgs,
binate: Binate,
docker: Arc<Docker>, docker: Arc<Docker>,
gui_state: Arc<Mutex<GuiState>>, gui_state: Arc<Mutex<GuiState>>,
initialised: bool, initialised: bool,
is_running: Arc<AtomicBool>, is_running: Arc<AtomicBool>,
receiver: Receiver<DockerMessage>, receiver: Receiver<DockerMessage>,
spawns: Arc<Mutex<HashMap<SpawnId, JoinHandle<()>>>>, spawns: Arc<Mutex<HashMap<SpawnId, JoinHandle<()>>>>,
timestamps: bool,
binate: Binate,
} }
impl DockerData { impl DockerData {
@@ -173,7 +173,7 @@ impl DockerData {
/// Get all current containers, handle into ContainerItem in the app_data struct rather than here /// Get all current containers, handle into ContainerItem in the app_data struct rather than here
/// Just make sure that items sent are guaranteed to have an id /// Just make sure that items sent are guaranteed to have an id
/// Will ignore any container that contains `oxker` as an entry point /// Will ignore any container that uses `./start_oxker.sh` as an entry point, unless the `-s` flag is set
pub async fn update_all_containers(&mut self) -> Vec<(bool, ContainerId)> { pub async fn update_all_containers(&mut self) -> Vec<(bool, ContainerId)> {
let containers = self let containers = self
.docker .docker
@@ -188,7 +188,11 @@ impl DockerData {
.into_iter() .into_iter()
.filter_map(|f| match f.id { .filter_map(|f| match f.id {
Some(_) => { Some(_) => {
if f.command.as_ref().map_or(false, |c| c.contains("oxker")) { if f.command
.as_ref()
.map_or(false, |c| c.starts_with("./start_oxker.sh"))
&& self.args.show_self
{
None None
} else { } else {
Some(f) Some(f)
@@ -200,9 +204,6 @@ impl DockerData {
self.app_data.lock().update_containers(&mut output); self.app_data.lock().update_containers(&mut output);
let current_sort = self.app_data.lock().get_sorted();
self.app_data.lock().set_sorted(current_sort);
// Just get the containers that are currently running, or being restarted, no point updating info on paused or dead containers // Just get the containers that are currently running, or being restarted, no point updating info on paused or dead containers
output output
.into_iter() .into_iter()
@@ -263,7 +264,7 @@ impl DockerData {
tokio::spawn(Self::update_log( tokio::spawn(Self::update_log(
docker, docker,
id.clone(), id.clone(),
self.timestamps, self.args.timestamp,
0, 0,
app_data, app_data,
spawns, spawns,
@@ -288,7 +289,7 @@ impl DockerData {
tokio::spawn(Self::update_log( tokio::spawn(Self::update_log(
docker, docker,
container.id.clone(), container.id.clone(),
self.timestamps, self.args.timestamp,
container.last_updated, container.last_updated,
app_data, app_data,
spawns, spawns,
@@ -323,6 +324,7 @@ impl DockerData {
let loading_spin = self.loading_spin(loading_uuid).await; let loading_spin = self.loading_spin(loading_uuid).await;
let all_ids = self.update_all_containers().await; let all_ids = self.update_all_containers().await;
self.update_all_container_stats(&all_ids); self.update_all_container_stats(&all_ids);
// Maybe only do a single one at first? // Maybe only do a single one at first?
@@ -410,22 +412,22 @@ impl DockerData {
/// Initialise self, and start the message receiving loop /// Initialise self, and start the message receiving loop
pub async fn init( pub async fn init(
args: CliArgs,
app_data: Arc<Mutex<AppData>>, app_data: Arc<Mutex<AppData>>,
docker: Arc<Docker>, docker: Arc<Docker>,
gui_state: Arc<Mutex<GuiState>>, gui_state: Arc<Mutex<GuiState>>,
receiver: Receiver<DockerMessage>, receiver: Receiver<DockerMessage>,
is_running: Arc<AtomicBool>, is_running: Arc<AtomicBool>,
) { ) {
let args = app_data.lock().args;
if app_data.lock().get_error().is_none() { if app_data.lock().get_error().is_none() {
let mut inner = Self { let mut inner = Self {
app_data, app_data,
args,
docker, docker,
gui_state, gui_state,
initialised: false, initialised: false,
receiver, receiver,
spawns: Arc::new(Mutex::new(HashMap::new())), spawns: Arc::new(Mutex::new(HashMap::new())),
timestamps: args.timestamp,
is_running, is_running,
binate: Binate::One, binate: Binate::One,
}; };
+9 -6
View File
@@ -121,13 +121,16 @@ impl InputHandler {
self.mouse_capture = !self.mouse_capture; self.mouse_capture = !self.mouse_capture;
} }
/// Sort containers based on a given header, switch asc to desc if already sorted, else always desc /// Sort containers based on a given header, if headings match, and already ascending, remove sorting
fn sort(&self, header: Header) { fn sort(&self, selected_header: Header) {
let mut output = Some((header, SortedOrder::Desc));
let mut locked_data = self.app_data.lock(); let mut locked_data = self.app_data.lock();
if let Some((h, order)) = locked_data.get_sorted().as_ref() { let mut output = Some((selected_header, SortedOrder::Asc));
if &SortedOrder::Desc == order && h == &header { if let Some((current_header, order)) = locked_data.get_sorted() {
output = Some((header, SortedOrder::Asc)); if current_header == selected_header {
match order {
SortedOrder::Desc => output = None,
SortedOrder::Asc => output = Some((selected_header, SortedOrder::Desc)),
}
} }
} }
locked_data.set_sorted(output); locked_data.set_sorted(output);
-1
View File
@@ -50,7 +50,6 @@ async fn main() {
let docker = Arc::new(docker); let docker = Arc::new(docker);
let is_running = Arc::clone(&is_running); let is_running = Arc::clone(&is_running);
tokio::spawn(DockerData::init( tokio::spawn(DockerData::init(
args,
docker_app_data, docker_app_data,
docker, docker,
docker_gui_state, docker_gui_state,
+5
View File
@@ -23,6 +23,10 @@ pub struct CliArgs {
#[clap(short = 'r', conflicts_with = "color")] #[clap(short = 'r', conflicts_with = "color")]
pub raw: bool, pub raw: bool,
/// Show self when running as a docker container
#[clap(short = 's')]
pub show_self: bool,
/// Don't draw gui - for debugging - mostly pointless /// Don't draw gui - for debugging - mostly pointless
#[clap(short = 'g')] #[clap(short = 'g')]
pub gui: bool, pub gui: bool,
@@ -43,6 +47,7 @@ impl CliArgs {
color: args.color, color: args.color,
docker_interval: args.docker_interval, docker_interval: args.docker_interval,
gui: !args.gui, gui: !args.gui,
show_self: !args.show_self,
raw: args.raw, raw: args.raw,
timestamp: !args.timestamp, timestamp: !args.timestamp,
} }
+1 -1
View File
@@ -364,7 +364,7 @@ pub fn heading_bar<B: Backend>(
if x == a { if x == a {
match b { match b {
SortedOrder::Asc => suffix = "", SortedOrder::Asc => suffix = "",
SortedOrder::Desc => suffix = "", SortedOrder::Desc => suffix = "",
} }
suffix_margin = 2; suffix_margin = 2;
color = Color::White; color = Color::White;