summaryrefslogtreecommitdiffstats
path: root/src/utils
Commit message (Collapse)AuthorAgeFilesLines
...
* live: revisit error log when failing to validate checksumOpenGnSys Support Team2024-06-271-1/+4
| | | | | | | | Add explicit check for .full.sum after downloading it. Rewrite errors log, one of them is misleading when checksum validation fails, it refers to missing .full.sum, but it could be a different reason.
* utils: remove bogus cache not found error after refresh commandAlejandro Sirgo Rica2024-06-071-1/+0
| | | | | | Remove log message "Cannot find device path to cache" spamming logs during operations such as refresh in clients without CACHE partition.
* utils: fix get_image_info regressionv1.3.2-10Alejandro Sirgo Rica2024-06-031-5/+6
| | | | | | | Fix image size, permissions and creation time. Improve error report related to these parameters now showing the exact cause of the problem if any occurred during the definition of image size, file permissions or image creation time values.
* src: cleanup ogGetImageInfoAlejandro Sirgo Rica2024-05-301-2/+11
| | | | | | Rename ogGetImageInfo to get_image_info. Move code from ogOperations.py to obtain image data into get_image_info.
* src: rename legacy.py into image.pyAlejandro Sirgo Rica2024-05-301-0/+0
| | | | | legacy.py contais mostly functions related to system images. Rename the file to better represent the contents in it.
* src: stop using hardcoded paths to cache image directoryAlejandro Sirgo Rica2024-05-301-4/+4
| | | | | | Use the constant OG_CACHE_IMAGE_PATH from cache.py to obtain the location of the directory where images are stored. This way the path can be changed from one single point.
* tiptorrent: check cache availability in tip_write_csumAlejandro Sirgo Rica2024-05-301-3/+4
| | | | | | Remove old TODO message. Check if the cache is available before trying to generate an image's checksum.
* utils: cache: redefine cache path constantsAlejandro Sirgo Rica2024-05-271-8/+9
| | | | | | | | | Rename OGIMG as OG_IMAGE_PATH. Rename OGCACHE_MOUNTPOINT as OG_CACHE_PATH. Define OG_CACHE_IMAGE_PATH as OG_CACHE_PATH + OG_IMAGE_PATH. This will serve to have a unique point to obtain cache related paths.
* utils: rename cache_probe() to get_cache_dev_path()OpenGnSys Support Team2024-05-092-6/+9
| | | | | | | | This method reports the /dev path to cache partition, rename it. Add explicit check if blkid is successful. And add logging to report that device path to cache is not found.
* utils: add error checks to checksum file creation in tip_write_csumAlejandro Sirgo Rica2024-05-071-2/+5
| | | | | Add a check for potential permission or IO errors during the creation of the image checksum.
* utils: add mkdir error report in mount_mkdirAlejandro Sirgo Rica2024-05-071-1/+5
| | | | | | Add exception checks to the os.mkdir operation and log the error found. The previous implementation was too optimistic and only handled mount related errors.
* utils: remove unused json importAlejandro Sirgo Rica2024-05-071-1/+0
| | | | | The json library was a dependency during the development of the boot OS functions and it is no longer needed in that file.
* utils:fs: fix logging statement in get_filesystem_typeAlejandro Sirgo Rica2024-05-071-1/+1
| | | | | Call the error() logging function from the logging object instead of the non existent log variable previously referenced.
* utils:fs: add mkfs logs when return code is not 0Alejandro Sirgo Rica2024-05-071-12/+24
| | | | | | Report mkfs failure for every partition. This does not raise an exception as that would skip partprobe operations and the mkfs operations in the next potentially well formated partitions.
* utils: add logging for checksum validationOpenGnSys Support Team2024-04-221-3/+9
| | | | Display if checksum validation is correct or not.
* utils: fs: incorrect indentationOpenGnSys Support Team2024-04-221-1/+1
|
* utils: fs: skip shrink/extend operation for fatOpenGnSys Support Team2024-04-191-0/+4
| | | | fat does not support this operation, skip it
* utils: fs: remove unused variable in _reduce_resize2fsv1.3.2-7OpenGnSys Support Team2024-04-191-1/+0
| | | | ret is set but never used in this method
* utils: fs: report error when failing to growOpenGnSys Support Team2024-04-191-2/+2
| | | | not really a warning, report an error instead
* utils: fs: set return value in ogReduceFsOpenGnSys Support Team2024-04-191-2/+3
| | | | | | | | otherwise error path uses uninitialized variable File "/opt/opengnsys/ogClient/src/utils/fs.py", line 112, in ogReduceFs return ret UnboundLocalError: local variable 'ret' referenced before assignment
* src: use explicit exception types in except Exception blocksAlejandro Sirgo Rica2024-04-032-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-038-49/+57
| | | | | | | | | | | | | | | | | | | 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.
* utils: refine log when booting windows UEFI from DOS partitionOpenGnSys Support Team2024-04-011-1/+1
| | | | | | Refine 97647c32aa2c utils: add enforce_gpt argument to get_efi_partition() to provide more explicit error when trying to boot Windows UEFI from DOS partition.
* utils: fix mount error messages for os probe operationsAlejandro Sirgo Rica2024-04-012-2/+2
| | | | | | | | Replace unexistent mountpoint variable to report a failed mount operation before an OS probe from a partition. Improve the semantics of the error message replacing 'at' with 'into'. Remove the period at the end of the log message.
* utils: make init_cache() use the cache mountpointAlejandro Sirgo Rica2024-03-261-1/+1
| | | | | | Make init_cache() use the actual cache mountpoint returned by the function mount_cache() for the creation of the cache directories instead of a hardcoded path.
* utils: remove redundant return statements from mount_mkdirAlejandro Sirgo Rica2024-03-261-3/+1
| | | | | | Remove return statement the program won't reach and simplify the return logic with a return from an if and a fallback return statement.
* utils: drop ogCopyEfiBootLoader scriptAlejandro Sirgo Rica2024-03-262-10/+52
| | | | | | | | 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.
* utils: add enforce_gpt argument to get_efi_partition()Alejandro Sirgo Rica2024-03-262-5/+8
| | | | | | | The Windows bootloader only supports a UEFI boot from a GPT partition. Set enforce_gpt to True in every codepath related to Windows. When enforce_gpt is set to True get_efi_partition() raises an exception when an MBR partition scheme is detected.
* revert 7f18485: improve uefi detection mechanismAlejandro Sirgo Rica2024-03-262-13/+3
| | | | | | | | | | | Make is_uefi_supported() only check for /sys/firmware/efi as get_efi_partition() will detect a missing ESP or an invalid partition scheme. Stop using get_efi_partition() inside is_uefi_supported() as the former is eventually called in every UEFI related code. UEFI supports both MBR and GPT as partition schemes and this is a required change to handle the particular case of Windows not being able to boot UEFI from a MBR partition scheme.
* src: make exception messages more contextual and explicitAlejandro Sirgo Rica2024-03-213-5/+5
| | | | | | | 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-1/+1
| | | | | | | | 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.
* utils: fix string not being defined as f-strings when they shouldAlejandro Sirgo Rica2024-03-211-2/+2
| | | | | Add the string prefix f'' to string instances formated as f-string but not properly constructed to expand the inline variables.
* src: centralize error logging into send_internal_server_errorAlejandro Sirgo Rica2024-03-215-41/+28
| | | | | | | | | | | | | | | | | | | | 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-4/+10
| | | | | | | | | | | | | | | | | | 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.
* utils: add disk index checks in get_partition_deviceAlejandro Sirgo Rica2024-03-211-1/+5
| | | | | Control the possibility of a bad disk index. Handle the checks in a similar fashion to the get_efi_partition function.
* utils: implement BIOS boot for LinuxAlejandro Sirgo Rica2024-03-212-1/+70
| | | | | | | | | Create a bios.py file to hold all the BIOS specific functions. Implement the _boot_bios_linux in Python. The new boot process tries to find the vmlinuz and initrd binaries at the desired partition. Then it tries to load them with kexec with the proper Grub boot params. One step closer to the removal of the boot legacy script.
* utils: handle exceptions caused by the hivex packageAlejandro Sirgo Rica2024-03-081-3/+6
| | | | | | The mage creation process was being interrupted by an error trying to read the Windows registry by the Hivex library. Now the exceptions are handled and an error is reported.
* utils: implement linux distro id detectionAlejandro Sirgo Rica2024-03-082-1/+27
| | | | | | | The OS probe logic must be able to check a distro programmatically, add get_linux_distro_id to return an id whitout versioning. Ensure the availability of 'ubuntu' when we need to ensure certain features are only used with a supported system.
* utils: move all boot from OS functionality into boot.pyAlejandro Sirgo Rica2024-03-081-6/+26
| | | | | | | | 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-082-3/+13
| | | | | | | 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.
* utils: handle missing file in getlinuxversion functionAlejandro Sirgo Rica2024-03-081-11/+15
| | | | | | The function getlinuxversion receives a path to the os-release file. The case of not being able to open it was not handled and thus causing an unwanted exception.
* utils: improve logging in the get_efi_partition functionAlejandro Sirgo Rica2024-03-081-13/+16
| | | | | Log each partition that gets checked and make the exception messages more informative.
* uefi: update EFIBOOTMGR_BIN to use /opt/opengnsys/sbin/efibootmgrv1.3.2-6OpenGnSys Support Team2024-03-051-1/+1
| | | | debian package with json support provides the binary through this path, update it.
* uefi: define EFIBOOTMGR_BIN to ease changing the efibootmgr binaryAlejandro Sirgo Rica2024-03-041-9/+11
| | | | | | The json functionality proposed upstream might be merged one day in efibootmgr so deploying a fork would not be needed anymore. This change aims to ease the migration once that day comes.
* live: drop IniciarSesion script when uefi booting into linuxAlejandro Sirgo Rica2024-03-041-6/+33
| | | | | | Replace IniciarSesion script in favor of native Python code when booting a UEFI system into Linux. This completes the implementation of booting into an OS on a UEFI compliant system.
* utils: add boot.pyJose M. Guisado2024-03-041-0/+63
| | | | | | | | | | Add utility module related to the process of booting a system from a client's partition. The main utility function to boot a clients system is boot_os_at(), from which firmware (UEFI or BIOS) and os-family specific private functions are invoked. This initial commit adds UEFI windows boot function.
* utils: add uefi.pyJose M. Guisado2024-03-041-0/+97
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Add UEFI related utilities inside a new utility module: uefi.py _check_efibootmgr_json ====================== Check if the system efibootmgr executable supports JSON output. This is a private function used only by other functions from uefi.py. is_uefi_supported ================= Check if the system supports UEFI firmware. run_efibootmgr_json =================== Runs efibootmgr with json output support. Return the JSON output as a Python dict. efibootmgr_create_bootentry =========================== Create nvram boot entry. This bootentry is usually later set to boot next just once via "BootNext" nvram variable. efibootmgr_delete_bootentry =========================== Delete a nvram boot entry. Used to avoid duplicates when booting the same disk and partition from a given client. efibootmgr_bootnext =================== Set nvram "BootNext" variable to a given boot entry so after client reboot, PXE is not executed and the given boot entry takes precedence. Add dependency with efibootmgr version >= 18, and efibootmgr JSON output which is currently out of tree from util-linux repo.
* probe: add basic os family detectionJose M. Guisado2024-03-041-0/+16
| | | | | | | | Add a basic OS family enumeration: OSFamily. Add utility function that probes for an installed Linux or Windows system, returns the corresponding enum value, OSFamily.UNKNOWN otherwise.
* disk: add get_efi_partition functionJose M. Guisado2024-03-041-0/+24
| | | | | | | | | | | | | Add utility function inside disk.py to find, if any, the first ESP partition of a given disk. The disk is provided as an integer (starting at 1 following OpenGnsys scripts usual values), meaning the (n-1)th disk from the disk array returned from get_disks(). In the future a better mechanism should be put in place to fetch probed disks from a running client. This change is part of the upcoming drop of "IniciarSesion" script in favor of a Python native approach. Specifically regarding UEFI systems.
* cache: improve loggingOpenGnSys Support Team2024-02-221-1/+1
| | | | | use info instead of debug to make it easier to debug problems when creating the cache.