client: make phd and cli read-write by default

Author: gjcolombo

bin/propolis-cli/src/main.rs

@@ -125,6 +125,10 @@ enum Command {
         /// Defaults to the most recent 16 KiB of console output (-16384).
         #[clap(long, short)]
         byte_offset: Option<i64>,
+
+        /// True if the serial console connection should be read-only.
+        #[clap(long, action)]
+        readonly: bool,
     },
 
     /// Migrate instance to new propolis-server
@@ -604,9 +608,11 @@ async fn stdin_to_websockets_task(
 async fn serial(
     addr: SocketAddr,
     byte_offset: Option<i64>,
+    readonly: bool,
     log: Logger,
 ) -> anyhow::Result<()> {
-    let mut ws_console = serial_connect(addr, byte_offset, log).await?;
+    let mut ws_console =
+        serial_connect(addr, byte_offset, readonly, log).await?;
 
     let _raw_guard = RawTermiosGuard::stdio_guard()
         .with_context(|| anyhow!("failed to set raw mode"))?;
@@ -699,6 +705,7 @@ async fn serial(
 async fn serial_connect(
     addr: SocketAddr,
     byte_offset: Option<i64>,
+    readonly: bool,
     log: Logger,
 ) -> anyhow::Result<InstanceSerialConsoleHelper> {
     let offset = match byte_offset {
@@ -707,7 +714,8 @@ async fn serial_connect(
         None => WSClientOffset::MostRecent(16384),
     };
 
-    Ok(InstanceSerialConsoleHelper::new(addr, offset, Some(log)).await?)
+    Ok(InstanceSerialConsoleHelper::new(addr, offset, readonly, Some(log))
+        .await?)
 }
 
 async fn migrate_instance(
@@ -914,8 +922,8 @@ async fn main() -> anyhow::Result<()> {
         }
         Command::Get => get_instance(&client).await?,
         Command::State { state } => put_instance(&client, state).await?,
-        Command::Serial { byte_offset } => {
-            serial(addr, byte_offset, log).await?
+        Command::Serial { byte_offset, readonly } => {
+            serial(addr, byte_offset, readonly, log).await?
         }
         Command::Migrate { dst_server, dst_port, dst_uuid, crucible_disks } => {
             let dst_addr = SocketAddr::new(dst_server, dst_port);

lib/propolis-client/src/support.rs

@@ -74,6 +74,7 @@ pub(crate) trait SerialConsoleStreamBuilder: Send {
         &mut self,
         address: SocketAddr,
         offset: WSClientOffset,
+        readonly: bool,
     ) -> Result<Box<dyn SerialConsoleStream>, WSError>;
 }
 
@@ -95,6 +96,7 @@ impl SerialConsoleStreamBuilder for PropolisSerialBuilder {
         &mut self,
         address: SocketAddr,
         offset: WSClientOffset,
+        readonly: bool,
     ) -> Result<Box<dyn SerialConsoleStream>, WSError> {
         let client = PropolisClient::new(&format!("http://{}", address));
         let mut req = client.instance_serial();
@@ -108,6 +110,7 @@ impl SerialConsoleStreamBuilder for PropolisSerialBuilder {
             }
         }
 
+        req = req.writable(!readonly);
         let upgraded = req
             .send()
             .await
@@ -157,6 +160,7 @@ impl<St: SerialConsoleStream + 'static> SerialConsoleStreamBuilder
         // offset is currently unused by this builder. Worth testing in
         // the future.
         _offset: WSClientOffset,
+        _readonly: bool,
     ) -> Result<Box<dyn SerialConsoleStream>, WSError> {
         if let Some((delay, stream)) =
             self.client_conns_and_delays.remove(&address)
@@ -191,6 +195,7 @@ pub enum WSClientOffset {
 pub struct InstanceSerialConsoleHelper {
     stream_builder: Box<dyn SerialConsoleStreamBuilder>,
     ws_stream: WebSocketStream<Box<dyn SerialConsoleStream>>,
+    readonly: bool,
     log: Option<Logger>,
 }
 
@@ -202,10 +207,12 @@ impl InstanceSerialConsoleHelper {
     pub async fn new(
         address: SocketAddr,
         offset: WSClientOffset,
+        readonly: bool,
         log: Option<Logger>,
     ) -> Result<Self, WSError> {
         let stream_builder = PropolisSerialBuilder::new();
-        Self::new_with_builder(stream_builder, address, offset, log).await
+        Self::new_with_builder(stream_builder, address, offset, readonly, log)
+            .await
     }
 
     /// Creates a new serial console helper for testing.
@@ -217,14 +224,16 @@ impl InstanceSerialConsoleHelper {
         connections: impl IntoIterator<Item = (SocketAddr, St)>,
         address: SocketAddr,
         offset: WSClientOffset,
+        readonly: bool,
         log: Option<Logger>,
     ) -> Result<Self, WSError> {
         let stream_builder = TestSerialBuilder::new(
             connections
                 .into_iter()
                 .map(|(addr, stream)| (addr, Duration::ZERO, stream)),
         );
-        Self::new_with_builder(stream_builder, address, offset, log).await
+        Self::new_with_builder(stream_builder, address, offset, readonly, log)
+            .await
     }
 
     /// Creates a new serial console helper for testing, with delays before
@@ -238,23 +247,31 @@ impl InstanceSerialConsoleHelper {
         connections: impl IntoIterator<Item = (SocketAddr, Duration, St)>,
         address: SocketAddr,
         offset: WSClientOffset,
+        readonly: bool,
         log: Option<Logger>,
     ) -> Result<Self, WSError> {
         let stream_builder = TestSerialBuilder::new(connections);
-        Self::new_with_builder(stream_builder, address, offset, log).await
+        Self::new_with_builder(stream_builder, address, offset, readonly, log)
+            .await
     }
 
     // Currently used for testing, and not exposed to clients.
     pub(crate) async fn new_with_builder(
         mut stream_builder: impl SerialConsoleStreamBuilder + 'static,
         address: SocketAddr,
         offset: WSClientOffset,
+        readonly: bool,
         log: Option<Logger>,
     ) -> Result<Self, WSError> {
-        let stream = stream_builder.build(address, offset).await?;
+        let stream = stream_builder.build(address, offset, readonly).await?;
         let ws_stream =
             WebSocketStream::from_raw_socket(stream, Role::Client, None).await;
-        Ok(Self { stream_builder: Box::new(stream_builder), ws_stream, log })
+        Ok(Self {
+            stream_builder: Box::new(stream_builder),
+            ws_stream,
+            readonly,
+            log,
+        })
     }
 
     /// Receives the next [WSMessage] from the server, holding it in
@@ -401,6 +418,7 @@ impl InstanceSerialConsoleMessage<'_> {
                         .build(
                             destination,
                             WSClientOffset::FromStart(from_start),
+                            self.helper.readonly,
                         )
                         .await?;
                     self.helper.ws_stream = WebSocketStream::from_raw_socket(
@@ -463,6 +481,7 @@ mod test {
             [(address, client_conn)],
             address,
             WSClientOffset::FromStart(0),
+            false,
             None,
         )
         .await
@@ -514,6 +533,7 @@ mod test {
             ],
             address_1,
             WSClientOffset::FromStart(0),
+            false,
             None,
         )
         .await

phd-tests/framework/src/test_vm/mod.rs

@@ -349,6 +349,7 @@ impl TestVm {
                     .server_addr(),
             ),
             WSClientOffset::MostRecent(0),
+            false,
             None,
         )
         .await?;