Merge pull request 'refs #1925 send /stopped on poweroff or restart' (#33) from agent-stopped-on-poweroff into main

Reviewed-on: opengnsys/ogclone-engine#33

CHANGELOG.md

@@ -5,6 +5,78 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.8.0] - 2025-04-23
+
+### Added
+
+- Have the oglive agent send /stopped on poweroff or restart
+
+## [0.7.2] - 2025-04-21
+
+### Fixed
+
+- Have the partitioning functions return a meaningful rc
+
+## [0.7.1] - 2025-04-15
+
+### Fixed
+
+- getConfiguration.py: don't fail if NTFS filesystems are mounted ro
+
+## [0.7.0] - 2025-04-15
+
+### Removed
+
+- Removed references to ogGlobals.OGLOG in python code
+
+## [0.6.1] - 2025-04-15
+
+### Fixed
+
+- Fixed capturing of partclone output and management of return value
+
+## [0.6.0] - 2025-04-15
+
+### Changed
+
+- ogGetIpAddress() is no longer required in ogGlobals--move it back into NetLib
+
+## [0.5.0] - 2025-04-15
+
+### Changed
+
+- Log to /var/log/clone-engine.log and clone-engine.json.log
+
+## [0.4.1] - 2025-04-10
+
+### Fixed
+
+- restoreImage.py: return negated rc to the shell
+
+## [0.4.0] - 2025-04-10
+
+### Changed
+
+- Make /opt/opengnsys writable in clients, just like it used to be
+
+## [0.3.6] - 2025-04-09
+
+### Fixed
+
+- Fixed ogReduceFs
+
+## [0.3.5] - 2025-04-09
+
+### Fixed
+
+- Fixed syntax
+
+## [0.3.4] - 2025-04-09
+
+### Fixed
+
+- Fixed usage of ogEcho in FileSystemLib
+
 ## [0.3.3] - 2025-04-09
 
 ### Fixed

Jenkins/Jenkinsfile-deb-pkg

@@ -48,7 +48,18 @@ pipeline {
                 }
             }
         }
-
+        stage('Generate Changelog (Nightly)'){
+            when {
+                branch 'main'
+            }
+            steps {
+                script {
+                    def devName = params.DEV_NAME ? params.DEV_NAME : env.DEFAULT_DEV_NAME
+                    def devEmail = params.DEV_EMAIL ? params.DEV_EMAIL : env.DEFAULT_DEV_EMAIL
+                    generateDebianChangelog(env.BUILD_DIR, devName, devEmail,"nightly")
+                }
+            }
+        }
         stage('Build') {
             steps {
                 script {
@@ -71,6 +82,19 @@ pipeline {
                 }
             }
         }
+        stage ('Publish to Debian Repository (Nightly)') {
+            when {
+                branch 'main'
+            }
+            agent { label 'debian-repo' }
+            steps {
+               script {
+                    // Construir el patrón de versión esperado en el nombre del paquete
+                    def versionPattern = "-${env.BUILD_NUMBER}~nightly"
+                    publicarEnAptly('/var/tmp/opengnsys/debian-repo/ogclient', 'nightly', versionPattern)
+                }
+            }
+        }
     }
     post {
         always {

etc/samba/smb-ogclient.conf

@@ -1,7 +1,7 @@
 [ogclient]
    comment = OpenGnsys Client
    browseable = no
-   writeable = no
+   writeable = yes 
    locking = no
    path = /opt/opengnsys/ogclient
    guest ok = no

ogclient/interfaceAdm/Apagar.py

@@ -2,6 +2,9 @@
 
 import os
 import sys
+import time
 
+os.system ('pkill -f OGAgent')
+time.sleep (3)
 os.system ('poweroff')
 sys.exit (0)

ogclient/interfaceAdm/Reiniciar.py

@@ -2,6 +2,9 @@
 
 import os
 import sys
+import time
 
+os.system ('pkill -f OGAgent')
+time.sleep (3)
 os.system ('reboot')
 sys.exit (0)

ogclient/interfaceAdm/getConfiguration.py

@@ -74,4 +74,5 @@ else:
 
 # Borramos marcas de arranque de Windows
 for f in glob.glob ('/mnt/*/ogboot.*') + glob.glob ('/mnt/*/*/ogboot.*'):
-    os.unlink (f)
+    try: os.unlink (f)
+    except: pass

ogclient/lib/python3/DiskLib.py

@@ -179,7 +179,7 @@ def ogCreatePartitions (disk, parts):
     p = subprocess.run (['sfdisk', DISK], input=sfdisk_input, capture_output=True, text=True)
     subprocess.run (['partprobe', DISK])
     if CACHESIZE: CacheLib.ogMountCache()
-    return True
+    return not p.returncode
 
 
 #/**
@@ -285,7 +285,7 @@ def ogCreateGptPartitions (disk, parts):
     p = subprocess.run (['sgdisk'] + DELOPTIONS + OPTIONS + [DISK], capture_output=True, text=True)
     subprocess.run (['partprobe', DISK])
     if CACHESIZE: CacheLib.ogMountCache()
-    return True
+    return not p.returncode
 
 
 #/**

ogclient/lib/python3/FileSystemLib.py

@@ -286,11 +286,7 @@ def ogGetFsSize (disk, par, unit='KB'):
     elif unit.upper() == "TB":
         factor = 1024 * 1024 * 1024
     elif unit.upper() != "KB":
-        SystemLib.ogRaiseError (
+        SystemLib.ogRaiseError ([], ogGlobals.OG_ERR_FORMAT, f"{unit} != {{ KB, MB, GB, TB }}")
-            [],
-            ogGlobals.OG_ERR_FORMAT,
-            f"{unit} != {{ KB, MB, GB, TB }}"
-        )
         return
 
     # Obtener el tamaño del sistema de archivo (si no está formateado; tamaño = 0).
@@ -331,11 +327,7 @@ def ogGetFsType(disk, part):
         try:
             subprocess.run(["zfs", "mount", PART])
         except FileNotFoundError:
-            SystemLib.ogRaiseError (
+            SystemLib.ogRaiseError ([], ogGlobals.OG_ERR_NOTEXEC, 'zfs')
-                [],
-                ogGlobals.OG_ERR_NOTEXEC,
-                'zfs'
-            )
             return
         out = subprocess.run(["mount"], capture_output=True, text=True).stdout.splitlines()
         for line in out:
@@ -344,11 +336,7 @@ def ogGetFsType(disk, part):
                 break
 
     if not TYPE:
-        SystemLib.ogRaiseError (
+        SystemLib.ogRaiseError ([], ogGlobals.OG_ERR_NOTFOUND, f'{disk} {part}')
-            [],
-            ogGlobals.OG_ERR_NOTFOUND,
-            f'{disk} {part}'
-        )
         return
 
     # Componer valores correctos.
@@ -592,11 +580,7 @@ def ogMountFs (disk, par):
             try:
                 rc = subprocess.run(['mount', dev, mntdir, '-o', 'force,remove_hiberfile'], check=True).returncode
             except subprocess.CalledProcessError:
-                SystemLib.ogRaiseError (
+                SystemLib.ogRaiseError ([], ogGlobals.OG_ERR_PARTITION, f"{disk}, {par}")
-                    [],
-                    ogGlobals.OG_ERR_PARTITION,
-                    f"{disk}, {par}"
-                )
                 return
 
             if 0 == rc:
@@ -605,26 +589,18 @@ def ogMountFs (disk, par):
                 try:
                     subprocess.run (['ntfsfix', '-d', par], check=True)
                 except subprocess.CalledProcessError:
-                    SystemLib.ogRaiseError (
+                    SystemLib.ogRaiseError ([], ogGlobals.OG_ERR_PARTITION, f"{disk, par}")
-                        [],
-                        ogGlobals.OG_ERR_PARTITION,
-                        f"{disk, par}"
-                    )
                     #return
             else:
                 try:
                     subprocess.run (['mount', par, mntdir, '-o', 'ro'], check=True)
                 except subprocess.CalledProcessError:
-                    SystemLib.ogRaiseError (
+                    SystemLib.ogRaiseError ([], ogGlobals.OG_ERR_PARTITION, f"{disk, par}")
-                        [],
-                        ogGlobals.OG_ERR_PARTITION,
-                        f"{disk, par}"
-                    )
                     #return
 
         # Aviso de montaje de solo lectura.
         if ogIsReadonly(disk, par):
-            SystemLib.ogEcho("warning", f'ogMountFs: {ogGlobals.lang.MSG_MOUNTREADONLY}: "{disk}, {par}"')
+            SystemLib.ogEcho ([], "warning", f'ogMountFs: {ogGlobals.lang.MSG_MOUNTREADONLY}: "{disk}, {par}"')
     else:
         # Montar sistema de archivos ZFS (un ZPOOL no comienza por "/").
         subprocess.run(['zfs', 'mount', dev])
@@ -716,7 +692,8 @@ def ogReduceFs (disk, par):
             break
     elif type == 'NTFS':
         ogUnmount (disk, par)
-        nr_lines = subprocess.run (['ntfsresize', '-fi', PART], capture_output=True, text=True).stdout.splitlines()
+        ntfsresize_out = subprocess.run (['ntfsresize', '-fi', PART], capture_output=True, text=True).stdout
+        nr_lines = ntfsresize_out.splitlines()
         maxsize = None
         size = None
         for l in nr_lines:
@@ -726,12 +703,10 @@ def ogReduceFs (disk, par):
                 size = l.split()[4]
                 size = int ((int (size) * 1.1 / 1024 + 1) * 1024)
 
-        if not maxsize and not size:
+        if not maxsize or not size:
-            SystemLib.ogRaiseError ([], ogGlobals.OG_ERR_PARTITION, f'{disk},{par}')
+            SystemLib.ogRaiseError ([], ogGlobals.OG_ERR_PARTITION, f'{disk},{par} ({ntfsresize_out})')
             return None
 
-        import time
-
         extrasize = 0
         retval = 1
         while retval != 0 and size+extrasize < maxsize:
@@ -809,18 +784,14 @@ def ogUnmountFs(disk, par):
     if MNTDIR:
         # Error si la particion está bloqueada.
         if ogIsLocked (disk, par):
-            SystemLib.ogRaiseError (
+            SystemLib.ogRaiseError ([], ogGlobals.OG_ERR_LOCKED, f"{ogGlobals.lang.MSG_PARTITION}, {disk} {par}")
-                [],
-                ogGlobals.OG_ERR_LOCKED,
-                f"{ogGlobals.lang.MSG_PARTITION}, {disk} {par}"
-            )
             return
 
         # Desmontar y borrar punto de montaje.
         try:
             subprocess.run(["umount", PART], check=True)
         except subprocess.CalledProcessError:
-            SystemLib.ogEcho("warning", f'ogUnmountFs: {ogGlobals.lang.MSG_DONTUNMOUNT}: "{disk}, {par}"')
+            SystemLib.ogEcho ([], "warning", f'ogUnmountFs: {ogGlobals.lang.MSG_DONTUNMOUNT}: "{disk}, {par}"')
         try:
             os.rmdir(MNTDIR)
         except:

ogclient/lib/python3/ImageLib.py

@@ -512,6 +512,8 @@ def ogRestoreImage (repo, imgpath, disk, par):
     rc = None
     try:
         p = subprocess.run (program, shell=True, capture_output=True, text=True)
+        print (p.stdout)
+        print (p.stderr)
         rc = p.returncode
         if not rc:
             SystemLib.ogRaiseError ([], ogGlobalsOG_ERR_IMAGE, f'{imgfile}, {disk}, {par}')

ogclient/lib/python3/NetLib.py

@@ -142,7 +142,29 @@ def ogGetHostname():
 #@note    Usa las variables utilizadas por el initrd "/etc/net-ethX.conf
 #*/ ##
 def ogGetIpAddress():
-    return ogGlobals.ogGetIpAddress()
+    if "IPV4ADDR" in os.environ:
+        ip = os.environ["IPV4ADDR"]
+        if '/' in ip: ip = ip.split ('/')[0]
+        return ip
+
+    extra_args = []
+    if "DEVICE" in os.environ:
+        extra_args = [ "dev", os.environ["DEVICE"] ]
+    ipas = subprocess.run (['ip', '-json', 'address', 'show', 'up'] + extra_args, capture_output=True, text=True).stdout
+
+    ipasj = json.loads (ipas)
+    addresses = []
+    for e in ipasj:
+        if 'lo' == e['ifname']: continue
+        if 'addr_info' not in e: continue
+        addrs = e['addr_info']
+        for a in addrs:
+            if 'inet' != a['family']: continue
+            addresses.append ({ 'local': a['local'], 'prefixlen': a['prefixlen'] })
+
+    if 1 != len (addresses):
+        raise Exception ('more than one local IP address found')
+    return addresses[0]
 
 
 #/**

ogclient/lib/python3/SystemLib.py

@@ -3,6 +3,7 @@ import datetime
 from zoneinfo import ZoneInfo
 import sys
 import os
+import json
 import shutil
 import inspect
 import glob
@@ -20,6 +21,7 @@ import StringLib
 
 def _logtype2logfile (t):
     if   'log'     == t.lower(): return ogGlobals.OGLOGFILE
+    if   'jsonlog' == t.lower(): return ogGlobals.OGJSONLOGFILE
     elif 'command' == t.lower(): return ogGlobals.OGLOGCOMMAND
     elif 'session' == t.lower(): return ogGlobals.OGLOGSESSION
     else: raise Exception (f'unknown log type ({t})')
@@ -35,24 +37,40 @@ def ogEcho (logtypes, loglevel, msg):
     logfiles = ['/dev/stdout']
     if type (logtypes) is list:
         for l in logtypes:
-            logfiles.append (_logtype2logfile (l))
+            if 'log' == l:
+                logfiles.append (_logtype2logfile ('log'))
+                logfiles.append (_logtype2logfile ('jsonlog'))
+            else:
+                logfiles.append (_logtype2logfile (l))
     else:   ## string
-        logfiles.append (_logtype2logfile (logtypes))
+        if 'log' == logtypes:
+            logfiles.append (_logtype2logfile ('log'))
+            logfiles.append (_logtype2logfile ('jsonlog'))
+        else:
+            logfiles.append (_logtype2logfile (logtypes))
 
     if loglevel is None or 'help' == loglevel:
         if ogGlobals.DEBUG.lower() != "no":
             logfiles.append (ogGlobals.OGLOGFILE)
+            logfiles.append (ogGlobals.OGJSONLOGFILE)
         for f in logfiles:
             with open (f, 'a') as fd:
-                fd.write (msg + '\n')
+                if ogGlobals.OGJSONLOGFILE == f:
+                    fd.write (json.dumps ({'message':msg}) + '\n')
+                else:
+                    fd.write (msg + '\n')
         return
 
     if 'info' == loglevel or 'warning' == loglevel or 'error' == loglevel:
-        DATETIME = datetime.datetime.now(ZoneInfo(ogGlobals.TZ)).strftime("%F %T %Z")
+        DATETIME      = datetime.datetime.now (ZoneInfo (ogGlobals.TZ)).strftime ('%F %T %Z')
+        DATETIME_json = datetime.datetime.now (ZoneInfo (ogGlobals.TZ)).strftime ('%Y-%m-%d %H:%M:%S')
 
         for f in logfiles:
             with open (f, 'a') as fd:
-                fd.write (f"OpenGnsys {loglevel} {DATETIME} {msg}\n")
+                if ogGlobals.OGJSONLOGFILE == f:
+                    fd.write (json.dumps ({'timestamp':DATETIME_json, 'severity':loglevel, 'message':msg}) + '\n')
+                else:
+                    fd.write (f"OpenGnsys {loglevel} {DATETIME} {msg}\n")
     else:
         raise Exception (f'unknown loglevel ({loglevel})')
 
@@ -75,10 +93,18 @@ def ogExecAndLog (logtypes, fun, *args, **kwargs):
     if type (logtypes) is list:
         for l in logtypes:
             logtypes = list (map (lambda x: x.lower(), logtypes))
-            logfiles.append (_logtype2logfile (l))
+            if 'log' == l:
+                logfiles.append (_logtype2logfile ('log'))
+                logfiles.append (_logtype2logfile ('jsonlog'))
+            else:
+                logfiles.append (_logtype2logfile (l))
     else:   ## string
         logtypes = logtypes.lower()
-        logfiles.append (_logtype2logfile (logtypes))
+        if 'log' == logtypes:
+            logfiles.append (_logtype2logfile ('log'))
+            logfiles.append (_logtype2logfile ('jsonlog'))
+        else:
+            logfiles.append (_logtype2logfile (logtypes))
 
     if not fun:
         ogRaiseError ([], ogGlobals.OG_ERR_FORMAT, 'no function provided')
@@ -103,7 +129,6 @@ def ogExecAndLog (logtypes, fun, *args, **kwargs):
     #    ## redirect stdout only
     #    eval $COMMAND      | tee -a $FILES
 
-    import time
     sout = serr = ''
     if 'command' in logtypes:
         os.unlink (ogGlobals.OGLOGCOMMAND)
@@ -121,14 +146,19 @@ def ogExecAndLog (logtypes, fun, *args, **kwargs):
     if sout or serr or ('True' != rc_str and 'False' != rc_str and 'None' != rc_str):
         for f in logfiles:
             with open (f, 'a') as fd:
-                if sout: fd.write (f'{sout}\n')
+                if ogGlobals.OGJSONLOGFILE == f:
-                if serr: fd.write (f'{serr}\n')
+                    if sout:   fd.write (json.dumps ({'message':sout})   + '\n')
-                if rc_str: fd.write (f'{rc_str}\n')
+                    if serr:   fd.write (json.dumps ({'message':serr})   + '\n')
-                #fd.write (f"ogExecAndLog: {fun.__name__} rc:\n{rc_str}\n")
+                    if rc_str: fd.write (json.dumps ({'message':rc_str}) + '\n')
-                #if sout: fd.write (f"ogExecAndLog: {fun.__name__} stdout:\n{sout}\n")
+                else:
-                #else:    fd.write (f"ogExecAndLog: {fun.__name__} stdout: (none)\n")
+                    if sout:   fd.write (f'{sout}\n')
-                #if serr: fd.write (f"ogExecAndLog: {fun.__name__} stderr:\n{serr}\n")
+                    if serr:   fd.write (f'{serr}\n')
-                #else:    fd.write (f"ogExecAndLog: {fun.__name__} stderr: (none)\n")
+                    if rc_str: fd.write (f'{rc_str}\n')
+                    #fd.write (f"ogExecAndLog: {fun.__name__} rc:\n{rc_str}\n")
+                    #if sout: fd.write (f"ogExecAndLog: {fun.__name__} stdout:\n{sout}\n")
+                    #else:    fd.write (f"ogExecAndLog: {fun.__name__} stdout: (none)\n")
+                    #if serr: fd.write (f"ogExecAndLog: {fun.__name__} stderr:\n{serr}\n")
+                    #else:    fd.write (f"ogExecAndLog: {fun.__name__} stderr: (none)\n")
 
     return rc
 

ogclient/lib/python3/ogGlobals.py

@@ -6,33 +6,6 @@ import os.path
 import locale
 import importlib.util
 
-## required for defining OGLOGFILE
-def ogGetIpAddress():
-    if "IPV4ADDR" in os.environ:
-        ip = os.environ["IPV4ADDR"]
-        if '/' in ip: ip = ip.split ('/')[0]
-        return ip
-
-    extra_args = []
-    if "DEVICE" in os.environ:
-        extra_args = [ "dev", os.environ["DEVICE"] ]
-    ipas = subprocess.run (['ip', '-json', 'address', 'show', 'up'] + extra_args, capture_output=True, text=True).stdout
-
-    ipasj = json.loads (ipas)
-    addresses = []
-    for e in ipasj:
-        if 'lo' == e['ifname']: continue
-        if 'addr_info' not in e: continue
-        addrs = e['addr_info']
-        for a in addrs:
-            if 'inet' != a['family']: continue
-            addresses.append ({ 'local': a['local'], 'prefixlen': a['prefixlen'] })
-
-    if 1 != len (addresses):
-        raise Exception ('more than one local IP address found')
-    return addresses[0]
-ip = ogGetIpAddress()
-
 def load_lang (name):
     global lang
     if name in sys.modules:
@@ -88,8 +61,8 @@ OGPYFUNCS = os.path.join (OPENGNSYS, 'functions')
 OGSCRIPTS = os.path.join (OPENGNSYS, 'scripts')
 OGIMG     = os.path.join (OPENGNSYS, 'images')
 OGCAC     = os.path.join (OPENGNSYS, 'cache')
-OGLOG     = os.path.join (OPENGNSYS, 'log')
+OGLOGFILE     = '/var/log/clone-engine.log'
-OGLOGFILE = f'{OGLOG}/{ip}.log'
+OGJSONLOGFILE = '/var/log/clone-engine.json.log'
 DEBUG = 'yes'
 _path = os.environ['PATH'] + ':/sbin:/usr/sbin:/usr/local/sbin:/bin:/usr/bin:/usr/local/bin:/opt/oglive/rootfs/opt/drbl/sbin'
 os.environ['PATH'] = ':'.join ([OGSCRIPTS, _path, OGAPI, OGBIN])

ogclient/scripts/deployImage.py

@@ -145,6 +145,10 @@ def main (repo, imgname, disk, par, proto='UNICAST', protoopt=''):
         SystemLib.ogEcho (['log', 'session'], None, f'[55] {ogGlobals.lang.MSG_HELP_ogRestoreImage}: restoreImage {params}')
         retval = subprocess.run (['restoreImage.py'] + params).returncode
 
+    ## turn shell's success into python success (without ending up with True or False)
+    if retval: retval = 0
+    else:      retval = 1
+
 # Mostrar resultados.
     resumerestoreimage = subprocess.run (['grep', '--max-count', '1', 'Total Time:', ogGlobals.OGLOGCOMMAND], capture_output=True, text=True).stdout
     SystemLib.ogEcho (['log', 'session'], None, f'   [ ]      {resumerestoreimage} ')

ogclient/scripts/listHardwareInfo.py

@@ -21,7 +21,7 @@ if len (sys.argv) > 1:
 #SERVERLOGDIR = unused
 
 # Fichero de listado:  hard-IP
-HARDFILE = f'{ogGlobals.OGLOG}/hard-{ogGetIpAddress()}'
+HARDFILE = f'/tmp/hard-{ogGetIpAddress()}'
 out = ogListHardwareInfo()
 with open (HARDFILE, 'w') as fd:
     fd.write (out)

ogclient/scripts/listSoftwareInfo.py

@@ -18,7 +18,7 @@ prog = os.path.basename (sys.argv[0])
 
 def main (disk, par, reduced):
     ip = NetLib.ogGetIpAddress()
-    softfile = f'{ogGlobals.OGLOG}/soft-{ip}-{disk}-{par}'
+    softfile = f'/tmp/soft-{ip}-{disk}-{par}'
     software_list = InventoryLib.ogListSoftware (disk, par)
 
     if reduced:

ogclient/scripts/restoreImage.py

@@ -114,5 +114,5 @@ t = time.time() - t0
 SystemLib.ogEcho (['log', 'session'], None, f'[100] Duracion de la operacion {int (t/60)}m {int (t%60)}s')
 
 # Código de salida del comando prinicpal de restauración.
-sys.exit (retval)
+sys.exit (not retval)     ## negated for the shell