Merge lp:~opensense/cubic/cubic-auto-20230201a into lp:cubic

[Open Sense Solutions]

added --auto-mode option for automatic builds including custom console script and files

auto-mode is accomplished by adding a virtual click of the "next" button after that button becomes active on each screen.

Parameters like iso and directory can be specified on the command line, and other settings that do not have command line options (ex. compression level) can be set by running cubic manually once and re-using the project directory.

When running in auto-mode a script is run instead of a console shell. There is a default script that does nothing but wait 10 seconds, otherwise if the file cubic-custom-console-script exists in the project directory that will be run instead.

If cubic-custom-console-files exists in the project directory it is made available in /var/tmp/ while cubic-custom-console-script is running.

Unmerged revisions

75. By Open Sense Solutions on 2023-02-02

added --auto-mode option for automatic builds including custom console script and files

=== added file 'usr/share/cubic/commands/cubic-console-script'
--- usr/share/cubic/commands/cubic-console-script	1970-01-01 00:00:00 +0000
+++ usr/share/cubic/commands/cubic-console-script	2023-02-02 03:30:33 +0000
@@ -0,0 +1,15 @@
+#!/bin/bash
+
+echo
+echo "You are seeing this message because you specified --auto_mode"
+echo "but did not create a file called cubic-custom-console-script" 
+echo "in the project directory." 
+echo
+echo "This default script doesn't do anything other than display these messages"
+echo "and wait 10 seconds."
+echo
+echo
+echo "Waiting 10 seconds before exiting the console..."
+sleep 10
+
+

=== modified file 'usr/share/cubic/commands/start-console'
--- usr/share/cubic/commands/start-console	2022-11-19 20:36:29 +0000
+++ usr/share/cubic/commands/start-console	2023-02-02 03:30:33 +0000
@@ -49,11 +49,41 @@
 number_arguments=${#}
 machine_name=${1}
 directory=${2}
+#auto_mode#
+project_directory=${3}
+parent_console_script=${4}
 
 # echo "program..................... ${program}"
 # echo "number of arguments......... ${number_arguments}"
 # echo "machine_name................ ${machine_name}"
-# echo "directory................... ${directory}"
+# echo "root directory.............. ${directory}"
+#auto_mode#
+# echo "project directory........... ${project_directory}"
+# echo "parent console script....... ${parent_console_script}"
+#
+# add ability to automatically run a script in the console
+#   the parameter passed in specifies the location in the parent system, 
+#   so we copy it into the local filesystem ( in /var/tmp/ ) and make it
+#   executable
+if [[ -n $parent_console_script ]] ; then
+	if [[ -e ${parent_console_script} ]] ; then
+		local_console_script=/var/tmp/cubic-console-script
+		local_console_script_in_parent=${directory}/$local_console_script
+		cp ${parent_console_script}  $local_console_script_in_parent
+		chmod +x ${directory}/$local_console_script
+
+		# sync in files from project directory/cubic-custom-console-files for the console script to use
+		if [[ -e "$project_directory/cubic-custom-console-files" ]] ; then
+			echo rsync -av $project_directory/cubic-custom-console-files/ ${directory}/var/tmp/cubic-custom-console-files/
+			     rsync -av $project_directory/cubic-custom-console-files/ ${directory}/var/tmp/cubic-custom-console-files/
+		fi
+	else
+		local_console_script=""
+	fi
+else
+		local_console_script=""
+fi
+
 
 ########################################################################
 # Command
@@ -122,7 +152,10 @@
     --register=yes                  \
     --bind-ro="${bind_path}"        \
     --machine="${machine_name}"     \
-    --directory="${directory}"
+    --directory="${directory}"      \
+    $local_console_script
+    #if local_console_script is empty then there is no positional command
+    #   argument to run and systemd-nspawn runs a shell
 else
     # Automatically handle resolv.conf as outlined in:
     # https://www.freedesktop.org/software/systemd/man/systemd-nspawn.html#--resolv-conf=
@@ -131,8 +164,19 @@
     --notify-ready=yes              \
     --register=yes                  \
     --machine="${machine_name}"     \
-    --directory="${directory}"
-fi
+    --directory="${directory}"      \
+    $local_console_script
+    #if local_console_script is empty then there is no positional command
+    #   argument to run and systemd-nspawn runs a shell
+fi
+
+#auto_mode# get rid of console script in /var/tmp which is not automatically erased like /tmp/
+#  note that we couldn't easily put it in /tmp/ because that is mounted as a tmpfs ( using ram ) 
+if [[ -e $local_console_script_in_parent ]] ; then
+	rm $local_console_script_in_parent
+	rm -rf ${directory}/var/tmp/cubic-custom-console-files/
+fi
+
 exit_code=$?
 exit $exit_code
 

=== modified file 'usr/share/cubic/cubic/pages/terminal_page.py'
--- usr/share/cubic/cubic/pages/terminal_page.py	2022-11-19 20:36:29 +0000
+++ usr/share/cubic/cubic/pages/terminal_page.py	2023-02-02 03:30:33 +0000
@@ -660,7 +660,14 @@
     is_running = status
 
     # Reset buttons based on status.
-    displayer.reset_buttons(is_back_sensitive=True, is_next_sensitive=status)
+
+    #auto_mode# in interactive usage the next navigation button is active as long as the terminal is active.  
+    #    but when running in auto mode we invert this behavior so we can continue when the terminal has finished
+    if model.arguments.auto_mode :
+        displayer.reset_buttons(is_back_sensitive=True, is_next_sensitive=not status)
+    else:
+        displayer.reset_buttons(is_back_sensitive=True, is_next_sensitive=status)
+
     displayer.set_sensitive('terminal_page__copy_header_bar_button', status)
 
     # Display the status.

=== modified file 'usr/share/cubic/cubic/utilities/console.py'
--- usr/share/cubic/cubic/utilities/console.py	2022-11-19 20:36:29 +0000
+++ usr/share/cubic/cubic/utilities/console.py	2023-02-02 03:30:33 +0000
@@ -105,7 +105,14 @@
     global status_callback
 
     first_time = True
-    reenter = True
+
+    #auto_mode# in interactive usage the terminal just respawns when you exit it
+    #    but when running in auto mode or with a custom_console_command we stop after the initial terminal exits
+    if model.arguments.auto_mode :
+        reenter = False
+    else:
+        reenter = True
+
     attempts = 0
     status_callback = new_status_callback
 
@@ -122,7 +129,21 @@
 
     program = os.path.join(model.application.directory, 'commands', 'start-console')
     # The command must be a list, as required by spawn_async().
-    command = ['pkexec', program, MACHINE_NAME, model.project.custom_root_directory]
+
+    #auto_mode# if running in auto mode, run default or custom script instead of a shell
+    #    it might be better to convert to keyword arguments intead of everything being positional
+    if model.arguments.auto_mode :
+        custom_script_file=os.path.join(model.project.directory,'cubic-custom-console-script')
+        if os.path.exists(custom_script_file):
+            script_file=custom_script_file
+        else:
+            script_file=os.path.join(model.application.directory,'commands','cubic-console-script')
+
+        logger.log_value('auto_mode: using console script', script_file)
+        command = ['pkexec', program, MACHINE_NAME, model.project.custom_root_directory, model.project.directory, script_file ]
+    else:
+        command = ['pkexec', program, MACHINE_NAME, model.project.custom_root_directory, model.project.directory ]
+
     display_command = ' '.join([os.path.basename(command[1].strip('"'))] + command[2:])
     logger.log_value('Command', display_command)
 

=== modified file 'usr/share/cubic/cubic/utilities/displayer.py'
--- usr/share/cubic/cubic/utilities/displayer.py	2021-12-27 18:45:40 +0000
+++ usr/share/cubic/cubic/utilities/displayer.py	2023-02-02 03:30:33 +0000
@@ -272,6 +272,28 @@
     if is_sensitive is not None:
         GLib.idle_add(Gtk.Button.set_sensitive, button, is_sensitive)
 
+    #auto_mode# look for the next button becoming active so we can auto click it
+    if model.arguments.auto_mode and name == "next_button" and is_sensitive == True :
+        logger.log_value('auto_mode: next_button was just set active, auto clicking in 5 seconds', True)
+        GLib.timeout_add(5000, next_button_auto_click)
+
+
+#auto_mode# function to trigger a click of the "next" button for automation
+def next_button_auto_click():
+        button = model.builder.get_object('next_button')
+        is_sensitive=button.get_sensitive()
+        logger.log_value('auto_mode: checking next button sensitivity',is_sensitive)
+        if is_sensitive:
+            button.clicked()
+            logger.log_value('auto_mode: clicked next button',True)
+            # don't run this function again automatically
+            return False
+        else:
+            logger.log_value('auto_mode: WARNING: next button is no longer active, not clicking it!',True)
+            # could return True here to try again after another timeout period but that should be unnecessary,
+            #    if things are working properly the next button should go active again and trigger this function again
+            return False
+
 
 def update_button_style(name, style):
     """

=== modified file 'usr/share/cubic/cubic_wizard.py'
--- usr/share/cubic/cubic_wizard.py	2022-12-01 23:17:25 +0000
+++ usr/share/cubic/cubic_wizard.py	2023-02-02 03:30:33 +0000
@@ -72,6 +72,10 @@
     description='Cubic (Custom Ubuntu ISO Creator) is a GUI wizard to create a customized Live ISO image for Ubuntu and Debian based distributions.')
 parser.add_argument('directory', nargs='?', help='directory for a new or existing project')
 parser.add_argument('iso', nargs='?', help='original ISO file for a new project (ignored for existing projects)')
+
+#auto_mode# add --auto-mode argument
+parser.add_argument("-a", "--auto-mode", action="store_true", help="automatically advance through each screen once the \"next\" button becomes active, will run cubic-custom-console-script in the console if it exists in the project directory, and will make the cubic-custom-console-files directory from the project directory available in /var/tmp/ while the cubic-custom-console-script is running")
+
 parser.add_argument("-v", "--verbose", action="store_true", help="output formatted log to the console")
 parser.add_argument("-V", "--version", action="store_true", help="print version information and exit")
 
@@ -128,6 +132,9 @@
         # logger.log_value('Original ISO file path argument', arguments.iso)
         model.arguments.file_path = os.path.realpath(arguments.iso)
 
+    #auto_mode# store this argument globally
+    model.arguments.auto_mode=arguments.auto_mode
+
     # Add additional mime types.
     mimetypes.init()
     file_path = os.path.join(model.application.directory, 'assets', 'mime.types')