summaryrefslogtreecommitdiffstats
path: root/src/live/ogOperations.py
Commit message (Collapse)AuthorAgeFilesLines
* live: fix omited error report in tip_client_getAlejandro Sirgo Rica2024-05-061-7/+6
| | | | | | | tip_client_get raises the proper error exceptions but the except block in _restore_image_tiptorrent overwrites the reported error. Move the raise statements in _restore_image_tiptorrent outside of the except block.
* live: revisit logging for partition setup, image create and restoreOpenGnSys Support Team2024-04-231-7/+5
|
* live: improve exception handling in image_createAlejandro Sirgo Rica2024-04-031-27/+34
| | | | | | | | | | | | | | | | | Reduce the scope of the try except block that controls the case of deleting the image backup in case of error. Now it only covers the section of code after backup creation and up to image verification. Check when the Exception is an OgError to raise with added context. Prevent the deletion of the target image in case of error before the backup creation. Bundle the backup creation on its own try except block to give more feedback on a failed backup creation. Enables a better error management allowing unhandled exceptions to be reported properly.
* src: use explicit exception types in except Exception blocksAlejandro Sirgo Rica2024-04-031-3/+3
| | | | | | | | Capture only the relevant exception types in each except block. The capture of the Exception type means hiding information for unhandled error cases, even for syntax errors in the codebase. Using a more fine grained exception filtering improves error traceability.
* src: log backtrace in unhandled error casesAlejandro Sirgo Rica2024-04-031-24/+25
| | | | | | | | | | | | | | | | | | | Log an error message in known error cases and log a backtrace otherwise. Define a new error type OgError to be used in all the 'raise' blocks to define the error message to log. The exception propagates until it reaches send_internal_server_error() where the exception type is checked. If the type is OgError we log the exception message. Logs the backtrace for other types. The initial error implementation printed a backtrace everytime an error ocurred. The next iteration changed it to only print a backtrace in a very particular case but ended up omiting too much information such as syntax errors or unknown error context. The actual implementation only logs the cases we already cover in the codebase and logs a bracktrace in the others, enabling a better debugging experience.
* Revert "live: improve lzop and partclone error handling"OpenGnSys Support Team2024-04-011-46/+27
| | | | | | | | This reverts commit 57787dab5499a38915b5e2f702844553abd2ea2a. Read from stderr is blocking if no data is available, revert this patch since ogClient hangs indefinitely in lzop invocations due to races in process execution through Popen.
* live: display info logging when restoring image startsOpenGnSys Support Team2024-03-271-2/+2
| | | | instead of using debug level, this is very useful to track the process.
* live: use .ant image as main image after image creation errorAlejandro Sirgo Rica2024-03-271-0/+6
| | | | | | | Restore image file from .ant to original file name if new image creation fails. Remove new imagen and move the .ant image file in place of the original as previously an error meant a rename of the image file without a revert to keep the image available.
* utils: drop ogCopyEfiBootLoader scriptAlejandro Sirgo Rica2024-03-261-1/+1
| | | | | | | | Implement a Python equivalent of ogCopyEfiBootLoader as the function copy_efi_bootloader. This function copies the contents of the folder of the EFI loader in the ESP into a ogBoot folder at the root of the partition target of an image creation. copy_efi_bootloader is a Windows only functionality.
* live: improve lzop and partclone error handlingAlejandro Sirgo Rica2024-03-261-27/+47
| | | | | | | | | | | Control non 0 returncode of the lzop and partclone subprocess in image creation and restoration because this means that either lzop or partclone has failed. The implementation must cover cases such as not enough storage space and log errors into /tmp/command.log and the log file of the client handling the request. Check the returncode of lzop and partclone subprocesses and log the stderr of the process reporting non zero returncode.
* live: improve logging in image_createAlejandro Sirgo Rica2024-03-261-2/+2
| | | | | | Log the whole context of the error when an exception happens. The previous exception handling was hidding important information about the cause of the error.
* src: make exception messages more contextual and explicitAlejandro Sirgo Rica2024-03-211-1/+1
| | | | | | | Provide more information in exception messages as those are the source of the logging messages. Add information about paths, files or configuration related to the operation associated to the exception.
* src: change generic exception types to be more explicitAlejandro Sirgo Rica2024-03-211-3/+3
| | | | | | | | Replace exception types to be more explicit about the nature of the error. Improve the exception raising semantics by using the 'from' keyword, this wraps an older exception into a new one so it is still considered the same object.
* src: centralize error logging into send_internal_server_errorAlejandro Sirgo Rica2024-03-211-38/+21
| | | | | | | | | | | | | | | | | | | | Use only the exception messages as the main resource for error messages. The previous error code had string duplication in the form of: logging.error('msg here') raise Exception('msg here') That approach also has the downside of having log duplication as it had the local logging.err() and a global logging.exception() inside send_internal_server_error capturing the exception message. The actual code only requires raising an exception with a proper error message. Improve exception messages to give more error context. Log every AssertionError as a backtrace. Use the 'raise Exception from e' syntax to modify the a previously raised exception 'e' into an exception with aditional context or different type. This also prevents the message that warns about newer exceptions being launch after an initial exception.
* utils: implement BIOS boot for windowsAlejandro Sirgo Rica2024-03-211-26/+0
| | | | | | | | | | | | | | | | | | Create ogboot.me and ogboot.secondboot as empty files and ogboot.firstboot with the value "iniciado" in the root of the BIOS Windows system partition. The files must contain data for GRUB to be able to write content, therefore these are created containing 3072 null bytes. The Windows boot process is handled by the "pxe" profile. There the files ogboot.me, ogboot.firstboot and ogboot.secondboot are used as a state machine to chose between booting Windows and ogLive. The first Windows boot happens if ogboot.me and ogboot.firstboot are identical, then "iniciado" is written in ogboot.firstboot. We skip this stage as we create ogboot.firstboot with 'iniciado'. The second Windows boot occurs if ogboot.me and ogboot.secondboot are boot identical, then "iniciado" is written in ogboot.secondboot. After the Windows boot ogLive is booted.
* live: check if cache partition is available before calling tiptorrentAlejandro Sirgo Rica2024-03-211-0/+4
| | | | | | The image restore command must check if the cache partition is available. Otherwise if the user forgets to create the cache tiptorrent fails.
* utils: move all boot from OS functionality into boot.pyAlejandro Sirgo Rica2024-03-081-19/+25
| | | | | | | | This change is a preparative for reimplementing the BIOS boot in order to deprecate the legacy script. All the codepaths to boot systems located at a partition are now called from the boot_os_at function enabling an easier structure for the incoming code.
* utils: improve uefi detection mechanismAlejandro Sirgo Rica2024-03-081-1/+1
| | | | | | | Checking the existence /sys/firmware/efi as it might appear sometimes in BIOS installs if the BIOS configuration is not proper. Checking for the EFI partition is the safest method to veryfy the install type.
* live: drop IniciarSesion script when uefi bootingJose M. Guisado2024-03-041-0/+10
| | | | | | | | Replace IniciarSesion script in favor of native Python code when booting a UEFI system. This applies when running the "session" command. WIP: Only UEFI boots Windows systems. Raise NotImplementedError exception trying to boot a Linux system using UEFI.
* live: improve logging with setup commandOpenGnSys Support Team2024-02-221-2/+10
| | | | | | Improve logging when setting up partition, provide more hints on progress. Fail in case partition layout is not supported.
* live: call partprobe on the specific diskOpenGnSys Support Team2024-02-191-1/+1
| | | | | otherwise partprobe does its best to find the disk, according to what I see through strace.
* poweroff: always call poweroff_oglive and _reboot_ogliveOpenGnSys Support Team2024-02-191-8/+2
| | | | Remove leftover fallback to directly call utilities to poweroff and reboot.
* live: split logging to warn not to turn off client during image creationOpenGnSys Support Team2024-02-151-1/+2
| | | | just split this log message.
* fs: check if writing md5sum to full.sum file failsOpenGnSys Support Team2024-02-151-3/+11
| | | | writing to file might fail (permission denied, disk full), check for errors.
* src: ogChangeRepo returns zero on success and -1 on errorOpenGnSys Support Team2024-02-151-2/+2
| | | | | | | | | | | | | | | | | | | | do not return the returncode, instead return an integer. do not use except CalledProcessError as e: it causes a another exception while handling exception. Remount the original image repository. it should be possible to simplify this further by: - stacking mounts, no need to umount initial repo and mount it again when switching to the new repo, because remount back initial repo might fail (!) - use check=False and simply check for x.returncode
* live: remove mbuffer leftover in image restore commandOpenGnSys Support Team2024-02-151-1/+0
| | | | | | | | | | | | | | | | | | | Remove mbuffer, this is never used. mbuffer has been never been used since ogClient supports native image restore. Originally this was used like this: partclone [...] | mbuffer -q -M 40M | lzop [...] supposely to speed up partclone in case the device where the read happens is slowier than the device that is used for writes. See mbuffer(1) manpage examples. In any case, this needs benchmarking to really make sure this is helping. Remove it until that ever happens.
* live: log message improvements for image creation and restoreOpenGnSys Support Team2024-02-151-6/+12
| | | | | Provide more context information for debugging issues with image creation and restore.
* src: improve error check in image_create and image_restoreAlejandro Sirgo Rica2024-02-141-2/+6
| | | | | | | | | cover more error cases where exceptions need to be raised. check return code in the invoked subprocess. restoreImageCustom has been intentionally left behind, it is unclear what this custom script returns on success and error.
* src: fix whitespace in ogOperations.pyAlejandro Sirgo Rica2024-02-141-13/+13
| | | | make whitespace conherent with the rest of the file contents.
* live: refine existing loggingOpenGnSys Support Team2023-12-181-2/+2
| | | | | - suggest to check permissions in samba folder - fix typo, s/filesyste/filesystem/
* live: adding logging to notify that image file already existsv1.3.2-4OpenGnSys Support Team2023-12-171-0/+3
| | | | Just informational, provide a notice that the file already exists.
* live: ensure image file exists after partcloneOpenGnSys Support Team2023-12-171-0/+4
| | | | check that there is a file and that is accessible
* live: display filesystem and device path if image_create() failsOpenGnSys Support Team2023-12-161-1/+1
| | | | display filesystem and path to device.
* live: validate rw access to image folder after remountOpenGnSys Support Team2023-12-161-0/+5
| | | | check that it is readable and writable
* live: report permissions and last update when creating imagev1.3.2-3OpenGnSys Support Team2023-12-121-3/+10
| | | | add .permissions and .lastupdate to json to report to ogserver.
* live: report image size when creating imageOpenGnSys Support Team2023-12-121-0/+9
| | | | add .size json field to report the real size of the image file.
* live: use legacy backup image suffixv1.3.2Jose M. Guisado2023-10-241-2/+1
| | | | | | | | | | | Image backup is considered a legacy feature. Use the legacy mechanism of naming image backups by adding ".ant" suffix. Previously, by using the strftime suffix clients were reporting that the disk were getting full rather quickly. When a good method for image deletion is implemented then a proper backup naming mechanism should be reconsidered.
* src: improve logging messagesJose M. Guisado2023-08-011-7/+10
| | | | | | | | | | | | | | | | | | | | | | | | | Some users have mistakenly reported tiptorrent problems when the process takes a long time. Specifically by rebooting or powering off the client in the middle of the md5sum computation stage, just after the tiptorrent transfer. Same problem occurs when image creation command takes a long period of time. In order to help the user understand the different stages of commands such as image creation or image restore using tiptorrent, the following changes have been made to the current logging solution: - Add log messages to warn users not to reboot or shut down the client during a tiptorrent transfer, and also during the md5sum computation stage. - Add a log message telling the user that the image creation processes have started. - Use logging.exception inside "except:" blocks to print a traceback with the log messsage. (https://docs.python.org/3/library/logging.html#logging.exception)
* live: add image backup option in image creationv1.3.1Jose M. Guisado2023-07-061-0/+6
| | | | | | | | | | | | Backup image file if image creation request included "backup": true This only applies when the target image is already present in the repository folder before running the partclone subprocess. This parameter is ignored if the target image is not present in the repository.
* src: remove unused legacy software inventory codeJose M. Guisado2023-05-171-15/+2
| | | | | | | | | | | | | Remove unnecessary InventarioSoftware invocation inside image_create operation. Software inventory is executed after image creation (see ogRest.py). Remove legacy 'path' parameter. This parameter was used to specify the path of a text file in which legacy bash scripts wrote the software inventory of the client (something like "Csft-{ip}..."). Fixes: 04bb35bd86b58c ("live: rewrite software inventory") Fixes: 2e3d47b7b8db69 ("Avoid writting /software output to a file")
* live: rewrite reboot operationv1.2.9Jose M. Guisado2023-05-091-5/+3
| | | | | | Add optional 'operation' parameter to _poweroff_oglive function. Reuse _poweroff_oglive code before the busybox subprocess when rebooting an ogLive client.
* live: rewrite poweroff operationJose M. Guisado2023-05-091-3/+20
| | | | | | | | | | | | | Replace legacy bash script /opt/opengnsys/client/scripts/poweroff with a Python native solution. Use subprocess module for any required external program when shutting down a client. ethtool is used to ensure WoL setting is correct before shutting down. ogLive does not properly use a init system so busybox is used when shutting down the system. In other live environments poweroff operation just calls /sbin/poweroff.
* live: rewrite hardware inventory commandJose M. Guisado2023-04-181-14/+12
| | | | | | | | | | | | | | | | Replace legacy shell script InventarioHardware for helper functions from hw_inventory.py Use get_hardware_inventory to obtain a HardwareInventory object with the hardware information. Map the HardwareInventory object to a legacy response string with the legacy_list_hardware_inventory function. Remove "Chrd-*" file reading logic, it's no longer needed. Legacy shell script InventarioHardware uses that file. Expect a change in the structure of hardware inventory response payload in the future. This patch does not address the HTTP response containing the hardware inventory as a '\n' separated string of hardware elements.
* utils: rename inventory.py to sw_inventory.pyJose M. Guisado2023-04-181-1/+1
| | | | | | | | Rename software inventory file to sw_inventory to better distinguish it from a future hardware inventory code. In the future sw_inventory and hw_inventory might be merged together once each file is tidied up.
* live: rewrite software inventoryv1.2.7Jose M. Guisado2023-03-271-19/+16
| | | | | | | | | | | | | | | | | | | | | | | | | | | Replace legacy bash script in favor of Python code. Improves error traceability and further development. The software inventory operation mounts the target partition and it fetches the list of installed software (package set). Once the operation is complete, it unmounts the target partition. For Windows, introduce hivex library python bindings for accessing Windows registry hive files (https://libguestfs.org/hivex.3.html). This operation is still processed by legacy code in the server side (ogAdmServer.c in ogServer). Legacy backend process expects the software inventory like the following example: "software": "Windows 10 Enterprise Evaluation 2004 \nIntel(R) Network Connections 24.0.0.11 24.0.0.11 ..." The os name is inserted first in this list followed by a '\n' separated string of the software packages. The legacy server code can be found in function actualizaSoftware at ogServer/src/ogAdmServer.c It is expected for software inventory payload to change in the future to a simpler solution using just a json array of strings.
* live: fix ogChangeRepo invocationJose M. Guisado2023-03-271-1/+1
| | | | | | | | | | | | | Add missing samba credentials parameter in ogChangeRepo invocation. Credentials are loaded from ogClient config file. Any production deployment should use its own samba user and password. ogChangeRepo fails when using default samba credentials in a production environment. Fixes: a1edbe904b30 ("legacy: rewrite ogChangeRepo") Fixes: 3703fd60634f ("live: support native unicast cache image restore")
* live: fix unicast cache error log messageJose M. Guisado2023-03-271-1/+1
| | | | | | | | | Removes undefined 'repo' variable from error logging message. This caused the traceback to be polluted with an unhelpful message about this variable being undefined. Fixes: 3703fd606 ("live: support native unicast cache image restore")
* legacy: rewrite ogChangeRepoJose M. Guisado2023-03-021-1/+1
| | | | | | | | | | | | | | | | Drop ogChangeRepo Bash script in favor of a native Python approach. Use only necessary subprocess calls instead of bringing all the logic of this function into a Bash script black box. ogChangeRepo unmounts the current OpenGnsys image samba folder (/opt/opengnsys/images) and mounts (connects to) a new directory using the new provided ip address. Keeping access mode from previous mount. If anything goes wrong when mounting the new directory, it will fallback to mounting the previous directory. If no previous OpenGnsys image samba directory is detected, this functions tries to mount the new directory anyway. In this case, it will raise CalledProcessError if something goes wrong.
* live: rewrite setup operationv1.2.5Jose M. Guisado2023-02-091-16/+44
| | | | | | | | | | | | | | | | Rewrites the setup operation using python-libfdisk module instead of an external bash script. Consolidating the operation into Python's code, limiting external subprocesses to well known programs and small concrete tasks that are difficult to fully integrate into Python. Use parttypes.py to fetch partition types from python-libfdisk module. Use fs.py to create any specified supported filesystem. OpenGnsys cache partitions are created labelling the partition as "CACHE". Stops setting non-standard MBR hexcode (0xca) to the cache partition in addition to the filesystem label. Any partition specified as type EMPTY will be ignored.
* live: clear ogbrowser log before image_createv1.2.4Jose M. Guisado2022-12-051-0/+1
| | | | | Remove any previous unrelated log message shown in the "real time log" html page before executing this command.