feat: Switch to generated response structs (#1007)

Drop manually created resource structures in favor of autogenerated ones.
With this we can also enable view configuration.

Author: gtema

doc/src/tui/config.md

@@ -21,7 +21,4 @@ with different value.
 Every resource view can be configured in a separate section of the config.
 Resource key in a form <SERVICE>.<RESOURCE>[/<SUBRESOURCE>] as used by the
 codegenerator is a name of a view. `fields` is an array of field names to be
-populated.
-
-NOTE: This a work in progress to pre-generate resource structures and column
-names.
+populated. All column names are forcibly converted to the UPPER CASE.

openstack_tui/.config/config.yaml

@@ -313,60 +313,86 @@ mode_aliases:
 views:
   # Block Storage
   block_storage.backup:
-    fields: [Id, Name, AZ, Size, Status, Created]
+    fields: [ID, NAME, AZ, SIZE, STATUS, CREATED_AT]
+    wide: true
   block_storage.snapshots:
-    fields: [Id, Name, Status, Created]
+    fields: [ID, NAME, STATUS, CREATED_AT]
+    wide: true
   block_storage.volume:
-    fields: [Id, Name, AZ, Size, Status, Updated]
+    fields: [ID, NAME, AZ, SIZE, STATUS, UPDATED_AT]
+    wide: true
   # Compute
   compute.aggregate:
-    fields: [Name, UUID, AZ, Updated]
+    fields: [NAME, UUID, AZ, UPDATED_AT]
+    wide: true
   compute.flavor:
-    fields: [Id, Name, vCPU, ram, disk, disabled]
+    fields: [ID, NAME, VCPUS, RAM, DISK]
+    wide: true
   compute.hypervisor:
-    fields: [IP, Hostname,Status, State]
+    fields: [IP, HOSTNAME, STATUS, STATE]
+    wide: true
   compute.server/instance_action/event:
-    fields: [Event, Result, Started, Finished, Host]
+    fields: [EVENT, RESULT, STARTED, FINISHED, HOST]
+    wide: true
   compute.server/instance_action:
-    fields: [Id, Action, Message, Started, User, "Server ID"]
+    fields: [ID, ACTION, MESSAGE, STARTED, USER, "SERVER ID"]
+    wide: true
   compute.server:
-    fields: [Id, Name, Status, Created, Updated]
+    fields: [ID, NAME, STATUS, CREATED, UPDATED]
+    wide: true
   # DNS
   dns.recordset:
-    fields: [Id, Name, Status, Created, Updated]
+    fields: [ID, NAME, STATUS, CREATED, UPDATED]
+    wide: true
   dns.zone:
-    fields: [Id, Name, Status, Created, Updated]
+    fields: [ID, NAME, STATUS, CREATED, UPDATED]
+    wide: true
   # Identity
   identity.group:
-    fields: [Id, Name, Domain, Description]
+    fields: [ID, NAME, DOMAIN, DESCRIPTION]
+    wide: true
   identity.project:
-    fields: [Id, Name, "Parent ID", Enabled, "Domain ID"]
+    fields: [ID, NAME, "PARENT ID", ENABLED, "DOMAIN ID"]
+    wide: true
   identity.user/application_credential:
-    fields: [Id, Name, "Expires at", "Unrestricted"]
+    fields: [ID, NAME, "EXPIRES AT", "UNRESTRICTED"]
+    wide: true
   identity.user:
-    fields: [Name, Domain, Enabled, Email, "Pwd expiry"]
+    fields: [NAME, DOMAIN, ENABLED, EMAIL, "PWD EXPIRY"]
+    wide: true
   # Image
   image.image:
-    fields: [Id, Name, Distro, Version, Arch, Visibility]
+    fields: [ID, NAME, DISTRO, VERSION, ARCH, VISIBILITY]
+    wide: true
   # Load Balancer
   load-balancer.healthmonitor:
-    fields: [Id, Name, Status, Type]
+    fields: [ID, NAME, STATUS, TYPE]
+    wide: true
   load-balancer.listener:
-    fields: [Id, Name, Status, Protocol, Port]
+    fields: [ID, NAME, STATUS, PROTOCOL, PORT]
+    wide: true
   load-balancer.loadbalancer:
-    fields: [Id, Name, Status, Address]
+    fields: [ID, NAME, STATUS, ADDRESS]
+    wide: true
   load-balancer.pool/member:
-    fields: [Id, Name, Status, Port]
+    fields: [ID, NAME, STATUS, PORT]
+    wide: true
   load-balancer.pool:
-    fields: [Id, Name, Status, Protocol]
+    fields: [ID, NAME, STATUS, PROTOCOL]
+    wide: true
   # Network
   network.network:
-    fields: [Id, Name, Status, Created, Updated]
+    fields: [ID, NAME, STATUS, CREATED_AT, UPDATED_AT]
+    wide: true
   network.router:
-    fields: [Id, Name, Status, Created, Updated]
+    fields: [ID, NAME, STATUS, CREATED_AT, UPDATED_AT]
+    wide: true
   network.subnet:
-    fields: [Id, Name, Cidr, Description, Created]
+    fields: [ID, NAME, CIDR, DESCRIPTION, CREATED_AT]
+    wide: true
   network.security_group_rule:
-    fields: [Id, Ethertype, Direction, Protocol, "Range Min", "Range Max"]
+    fields: [ID, ETHERTYPE, DIRECTION, PROTOCOL, "RANGE MIN", "RANGE MAX"]
+    wide: true
   network.security_group:
-    fields: [Id, Name, Created, Updated]
+    fields: [ID, NAME, CREATED_AT, UPDATED_AT]
+    wide: true

openstack_tui/src/components/block_storage/backups.rs

@@ -15,54 +15,33 @@
 use crossterm::event::KeyEvent;
 use eyre::Result;
 use ratatui::prelude::*;
-use serde::Deserialize;
-use structable_derive::StructTable;
 use tokio::sync::mpsc::UnboundedSender;
 
 use crate::{
     action::Action,
     cloud_worker::block_storage::v3::{
-        BlockStorageApiRequest, BlockStorageBackupApiRequest, BlockStorageBackupList,
+        BlockStorageApiRequest, BlockStorageBackup, BlockStorageBackupApiRequest,
+        BlockStorageBackupList,
     },
     cloud_worker::types::ApiRequest,
     components::{table_view::TableViewComponentBase, Component},
     config::Config,
     error::TuiError,
     mode::Mode,
-    utils::{OutputConfig, ResourceKey, StructTable},
+    utils::ResourceKey,
 };
 
 const TITLE: &str = "Backups";
 const VIEW_CONFIG_KEY: &str = "block_storage.backup";
 
-#[derive(Deserialize, StructTable)]
-pub struct BackupData {
-    #[structable(title = "Id", wide)]
-    id: String,
-    #[structable(title = "Name", optional)]
-    #[serde(default)]
-    name: Option<String>,
-    #[structable(title = "AZ", optional)]
-    #[serde(default)]
-    availability_zone: Option<String>,
-    #[structable(title = "Size")]
-    #[serde(default)]
-    size: u32,
-    #[structable(title = "Status")]
-    #[serde(default)]
-    status: String,
-    #[structable(title = "Created")]
-    #[serde(default)]
-    created_at: String,
-}
-
-impl ResourceKey for BackupData {
+impl ResourceKey for BlockStorageBackup {
     fn get_key() -> &'static str {
         VIEW_CONFIG_KEY
     }
 }
 
-pub type BlockStorageBackups<'a> = TableViewComponentBase<'a, BackupData, BlockStorageBackupList>;
+pub type BlockStorageBackups<'a> =
+    TableViewComponentBase<'a, BlockStorageBackup, BlockStorageBackupList>;
 
 impl Component for BlockStorageBackups<'_> {
     fn register_config_handler(&mut self, config: Config) -> Result<(), TuiError> {

openstack_tui/src/components/block_storage/snapshots.rs

@@ -15,46 +15,33 @@
 use crossterm::event::KeyEvent;
 use eyre::Result;
 use ratatui::prelude::*;
-use serde::Deserialize;
-use structable_derive::StructTable;
 use tokio::sync::mpsc::UnboundedSender;
 
 use crate::{
     action::Action,
     cloud_worker::block_storage::v3::{
-        BlockStorageApiRequest, BlockStorageSnapshotApiRequest, BlockStorageSnapshotList,
+        BlockStorageApiRequest, BlockStorageSnapshot, BlockStorageSnapshotApiRequest,
+        BlockStorageSnapshotList,
     },
     cloud_worker::types::ApiRequest,
     components::{table_view::TableViewComponentBase, Component},
     config::Config,
     error::TuiError,
     mode::Mode,
-    utils::{OutputConfig, ResourceKey, StructTable},
+    utils::ResourceKey,
 };
 
 const TITLE: &str = "Snapshots";
 const VIEW_CONFIG_KEY: &str = "block_storage.snapshot";
 
-#[derive(Deserialize, StructTable)]
-pub struct SnapshotData {
-    #[structable(title = "Id", wide)]
-    id: String,
-    #[structable(title = "Name")]
-    name: String,
-    #[structable(title = "Status")]
-    status: String,
-    #[structable(title = "Created")]
-    created_at: String,
-}
-
-impl ResourceKey for SnapshotData {
+impl ResourceKey for BlockStorageSnapshot {
     fn get_key() -> &'static str {
         VIEW_CONFIG_KEY
     }
 }
 
 pub type BlockStorageSnapshots<'a> =
-    TableViewComponentBase<'a, SnapshotData, BlockStorageSnapshotList>;
+    TableViewComponentBase<'a, BlockStorageSnapshot, BlockStorageSnapshotList>;
 
 impl Component for BlockStorageSnapshots<'_> {
     fn register_config_handler(&mut self, config: Config) -> Result<(), TuiError> {

openstack_tui/src/components/block_storage/volumes.rs

@@ -15,51 +15,47 @@
 use crossterm::event::KeyEvent;
 use eyre::{Result, WrapErr};
 use ratatui::prelude::*;
-use serde::Deserialize;
-use structable_derive::StructTable;
 use tokio::sync::mpsc::UnboundedSender;
 use tracing::debug;
 
 use crate::{
     action::Action,
     cloud_worker::block_storage::v3::{
-        BlockStorageApiRequest, BlockStorageVolumeApiRequest, BlockStorageVolumeDeleteBuilder,
-        BlockStorageVolumeList,
+        BlockStorageApiRequest, BlockStorageVolume, BlockStorageVolumeApiRequest,
+        BlockStorageVolumeDelete, BlockStorageVolumeDeleteBuilder,
+        BlockStorageVolumeDeleteBuilderError, BlockStorageVolumeList,
     },
     cloud_worker::types::ApiRequest,
     components::{table_view::TableViewComponentBase, Component},
     config::Config,
     error::TuiError,
     mode::Mode,
-    utils::{OutputConfig, ResourceKey, StructTable},
+    utils::ResourceKey,
 };
 
 const TITLE: &str = "Volumes";
 const VIEW_CONFIG_KEY: &str = "block_storage.volume";
 
-#[derive(Deserialize, StructTable)]
-pub struct VolumeData {
-    #[structable(title = "Id", wide)]
-    id: String,
-    #[structable(title = "Name")]
-    name: String,
-    #[structable(title = "AZ")]
-    availability_zone: String,
-    #[structable(title = "Size")]
-    size: u32,
-    #[structable(title = "Status")]
-    status: String,
-    #[structable(title = "Updated")]
-    updated_at: String,
-}
-
-impl ResourceKey for VolumeData {
+impl ResourceKey for BlockStorageVolume {
     fn get_key() -> &'static str {
         VIEW_CONFIG_KEY
     }
 }
 
-pub type BlockStorageVolumes<'a> = TableViewComponentBase<'a, VolumeData, BlockStorageVolumeList>;
+pub type BlockStorageVolumes<'a> =
+    TableViewComponentBase<'a, BlockStorageVolume, BlockStorageVolumeList>;
+
+impl TryFrom<&BlockStorageVolume> for BlockStorageVolumeDelete {
+    type Error = BlockStorageVolumeDeleteBuilderError;
+    fn try_from(value: &BlockStorageVolume) -> Result<Self, Self::Error> {
+        let mut builder = BlockStorageVolumeDeleteBuilder::default();
+        builder.id(value.id.clone());
+        if let Some(val) = &value.name {
+            builder.name(val.clone());
+        }
+        builder.build()
+    }
+}
 
 impl Component for BlockStorageVolumes<'_> {
     fn register_config_handler(&mut self, config: Config) -> Result<(), TuiError> {
@@ -120,11 +116,8 @@ impl Component for BlockStorageVolumes<'_> {
                             // send action to set SecurityGroupRulesList
                             command_tx.send(Action::Confirm(ApiRequest::from(
                                 BlockStorageVolumeApiRequest::Delete(Box::new(
-                                    BlockStorageVolumeDeleteBuilder::default()
-                                        .id(selected_entry.id.clone())
-                                        .name(selected_entry.name.clone())
-                                        .build()
-                                        .wrap_err("cannot prepare request")?,
+                                    BlockStorageVolumeDelete::try_from(selected_entry)
+                                        .wrap_err("error preparing OpenStack request")?,
                                 )),
                             )))?;
                         }

openstack_tui/src/components/compute/aggregates.rs

@@ -15,45 +15,31 @@
 use crossterm::event::KeyEvent;
 use eyre::Result;
 use ratatui::prelude::*;
-use serde::Deserialize;
-use structable_derive::StructTable;
 use tokio::sync::mpsc::UnboundedSender;
 
 use crate::{
     action::Action,
     cloud_worker::compute::v2::{
-        ComputeAggregateApiRequest, ComputeAggregateList, ComputeApiRequest,
+        ComputeAggregate, ComputeAggregateApiRequest, ComputeAggregateList, ComputeApiRequest,
     },
     cloud_worker::types::ApiRequest,
     components::{table_view::TableViewComponentBase, Component},
     config::Config,
     error::TuiError,
     mode::Mode,
-    utils::{OutputConfig, ResourceKey, StructTable},
+    utils::ResourceKey,
 };
 
 const TITLE: &str = "Compute Aggregates";
 const VIEW_CONFIG_KEY: &str = "compute.aggregate";
 
-#[derive(Deserialize, StructTable)]
-pub struct AggregateData {
-    #[structable(title = "Name")]
-    name: String,
-    #[structable(title = "UUID")]
-    uuid: String,
-    #[structable(title = "AZ")]
-    availability_zone: String,
-    #[structable(title = "Updated")]
-    updated_at: String,
-}
-
-impl ResourceKey for AggregateData {
+impl ResourceKey for ComputeAggregate {
     fn get_key() -> &'static str {
         VIEW_CONFIG_KEY
     }
 }
 
-pub type ComputeAggregates<'a> = TableViewComponentBase<'a, AggregateData, ComputeAggregateList>;
+pub type ComputeAggregates<'a> = TableViewComponentBase<'a, ComputeAggregate, ComputeAggregateList>;
 
 impl Component for ComputeAggregates<'_> {
     fn register_config_handler(&mut self, config: Config) -> Result<(), TuiError> {