Add --maintenance-window-start to create command.

Adds a new flag to the cluster `create` command for setting the
desired hour of day which a maintenance window can possibly start.

Valid values for this flag are `0 - 23`. Also, this flag is NOT allowed
on with `--fork` or `--replica`.

Author: abrightwell

CHANGELOG.md

@@ -5,6 +5,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+### Added
+- `cb create` now accepts `--maintenance-window-start`.
 
 ## [3.6.5] - 2024-04-30
 - Missing values from cluster upgrade operation state enum

spec/cb/cluster_create_spec.cr

@@ -92,6 +92,28 @@ Spectator.describe CB::ClusterCreate do
     end
   end
 
+  describe "#maintenance_window_start=" do
+    sample [nil, 0, 23] do |start|
+      it "allows valid values" do
+        expect(&.maintenance_window_start = start).to_not raise_error
+      end
+    end
+
+    it "does not allow `--maintenance-window-start` with `--fork`" do
+      action.fork = cluster.id
+      action.maintenance_window_start = 0
+
+      expect(&.pre_validate).to raise_error(Program::Error, "Cannot use '--maintenance-window-start' with '--fork' or '--replica'")
+    end
+
+    it "does not allow `--maintenance-window-start` with `--replica`" do
+      action.fork = cluster.id
+      action.maintenance_window_start = 0
+
+      expect(&.pre_validate).to raise_error(Program::Error, "Cannot use '--maintenance-window-start' with '--fork' or '--replica'")
+    end
+  end
+
   describe "#team=" do
     sample invalid_ids do |team|
       it "does not allow invalid values" do
@@ -165,6 +187,14 @@ Spectator.describe CB::ClusterCreate do
       expect(&.call).to raise_error(CB::Program::Error, "Must also specify '--region' for a 'gcp' based network.")
     end
 
+    it "raises error when maintenance_window_start is invalid" do
+      action.plan = "hobby-2"
+      action.platform = "aws"
+      action.region = "east"
+      action.maintenance_window_start = 24
+      expect(&.call).to raise_error(CB::Program::Error, "Invalid value for '--maintenance-window-start', valid values: 0 - 23")
+    end
+
     it "raises error when region or provider given with non-gcp network" do
       network = Factory.network
 

src/cb/cluster_create.cr

@@ -13,9 +13,24 @@ class CB::ClusterCreate < CB::APIAction
   eid_setter replica, "replica id"
   eid_setter fork, "fork id"
   property at : Time?
+  i32_setter maintenance_window_start
 
-  def pre_validate
+  private def validate_fork_and_replica
     raise Error.new "Cannot use both '--fork' and '--replica' at the same time." if fork && replica
+  end
+
+  private def validate_maintenance_window_with_fork_or_replica
+    raise Error.new "Cannot use '--maintenance-window-start' with '--fork' or '--replica'" if maintenance_window_start && (fork || replica)
+  end
+
+  private def validate_maintenance_window_range
+    raise Error.new "Invalid value for '--maintenance-window-start', valid values: 0 - 23" if (start = maintenance_window_start) && !start.in?(0..23)
+  end
+
+  def pre_validate
+    validate_fork_and_replica
+    validate_maintenance_window_with_fork_or_replica
+    validate_maintenance_window_range
 
     if id = fork || replica
       source = client.get_cluster id
@@ -69,9 +84,10 @@ class CB::ClusterCreate < CB::APIAction
               else
                 @client.create_cluster CB::Client::ClusterCreateParams.new(**params.merge(
                   is_ha: @ha,
+                  maintenance_window_start: @maintenance_window_start,
+                  postgres_version_id: @postgres_version,
                   storage: @storage,
                   team_id: @team.to_s,
-                  postgres_version_id: @postgres_version,
                 ))
               end
 

src/cb/completion.cr

@@ -223,6 +223,7 @@ class CB::Completion
     suggest << "--fork\tcluster to fork" unless has_full_flag?(:fork) || has_full_flag?(:replica)
     suggest << "--ha\thigh availability" unless has_full_flag?(:ha) || has_full_flag?(:replica)
     suggest << "--help\tshow help" if args.size == 2
+    suggest << "--maintenance-window-start\tstart hour for maintenance window" unless has_full_flag? :maintenance_window_start
     suggest << "--name\tcluster name" unless has_full_flag? :name
     suggest << "--network\tnetwork id" unless has_full_flag? :network
     suggest << "--platform\tcloud provider" unless has_full_flag? :platform
@@ -240,6 +241,7 @@ class CB::Completion
     return suggest_none if last_arg? "-n", "--name"
     return suggest_none if last_arg? "--network"
     return suggest_none if last_arg? "-v", "--version"
+    return suggest_none if last_arg? "--maintenance-window-start"
 
     create_fork_suggest.tap { |s| return s if s } if args.includes? "--fork"
     create_replica_suggest.tap { |s| return s if s } if args.includes? "--replica"
@@ -1383,6 +1385,7 @@ class CB::Completion
     full << :use_cluster_maintenance_window if has_full_flag? "use-cluster-maintenance-window"
     full << :no_header if has_full_flag? "--no-header"
     full << :peering if has_full_flag? "--peering"
+    full << :maintenance_window_start if has_full_flag? "--maintenance-window-start"
     full
   end
 

src/cli.cr

@@ -152,6 +152,7 @@ op = OptionParser.new do |parser|
     parser.on("-v VERSION", "--version VERSION", "Postgres major version") { |arg| create.postgres_version = arg }
     parser.on("-s GiB", "--storage GiB", "Storage size (default: 100GiB, or same as source)") { |arg| create.storage = arg }
     parser.on("-t ID", "--team ID", "Team") { |arg| create.team = arg }
+    parser.on("--maintenance-window-start START", "Maintenance window start hour (Valid values: 0 - 23)") { |arg| create.maintenance_window_start = arg }
     parser.on("--network network", "Network") { |arg| create.network = arg }
 
     parser.on("--replica ID", "Choose source cluster for read-replica") { |arg| create.replica = arg }

src/client/cluster.cr

@@ -89,6 +89,7 @@ module CB
     struct ClusterCreateParams < CommonCreateParams
       property environment : String?
       property is_ha : Bool?
+      property maintenance_window_start : Int32?
       property postgres_version_id : Int32?
       property storage : Int32?
       property team_id : String
@@ -97,6 +98,7 @@ module CB
         @name, @plan_id, @provider_id, @region_id, @team_id,
         @environment = nil,
         @is_ha = nil,
+        @maintenance_window_start = nil,
         @postgres_version_id = nil,
         @storage = nil,
         @network_id = nil