Make sure that if everything fails, to check /etc/dc for thedc-binary.

.gitignore

@@ -1,3 +1,4 @@
 tags
 *.tags
 *.user
+documentation/

DownloadDCFirmware/DownloadDCFirmware.pro

@@ -86,7 +86,7 @@ SOURCES += \
 
 HEADERS += \
         ../common/include/message_handler.h \
-        ../common/src/commandline_parser.h \
+        ../common/include/commandline_parser.h \
         update.h \
         ../common/include/System.h \
         ../common/include/utils_internal.h \

DownloadDCFirmware/main.cpp

@@ -67,11 +67,11 @@ int main(int argc, char **argv) {
 
     //return 0;
 
-/*
     CommandLineParser parser;
     parser.process(a);
     parser.readSettings();
 
+/*
     QString repositoryUrl = parser.repositoryUrl();
     QString plugInDir = parser.plugInDir();
     QString plugInName = parser.plugInName();
@@ -80,6 +80,7 @@ int main(int argc, char **argv) {
     QString psaTariffDir = parser.psaTariffDir();
     QString psaDcDir = parser.dcDir();
     QString iniFileName = parser.iniFileName();
+    bool debug = parser.debug();
     bool const dryRun = parser.dryRun();
     bool const noUpdatePsaHardware = parser.noUpdatePsaHardware();
     bool const showYoctoVersion = parser.yoctoVersion();
@@ -133,11 +134,13 @@ int main(int argc, char **argv) {
     QString const &customerRepo
         = QDir::cleanPath(workingDir + QDir::separator() + QString("customer_%1").arg(customerNr));
 */
-
+    QString psaDcDir = internal::customerRepoDcDir();
-    QString const &psaDcDir = internal::customerRepoDcDir();
+    QString psaRepoRootDir = internal::customerRepoRoot();
-    QString const &psaRepoRootDir = internal::customerRepoRoot();
+    QString psaRepoDir = internal::customerRepoDir();
-    QString const &psaRepoDir = internal::customerRepoDir();
+    QString branchName = internal::branchName();
-    QString const &branchName = internal::branchName();
+    QString rootDir = "/etc/dc/";
+    // bool usbDetected = false;
+    // bool sdCardDetected = false;
 
     bool debug = false;
     bool noaction = true;
@@ -145,38 +148,68 @@ int main(int argc, char **argv) {
     QString libca;
 
     std::unique_ptr<QSettings> settings = internal::readSettings();
-
     if (settings) {
         settings->beginGroup("ATBUpdateDC");
         debug = settings->value("debug", false).toBool();
         workingDir = settings->value("workingdir", "/tmp").toString();
         libca = settings->value("libca", "/usr/lib/libCAslave.so").toString();
         settings->endGroup();
+    } else {
+        qCritical() << "count not read ATBUpdateTool.ini";
+        return -1;
+    }
+
+    QString dcDir = parser.dcDir();
+    if (!dcDir.isEmpty()) {
+        psaDcDir = dcDir;
+    }
+    debug = parser.debug();
+
+    if (debug) {
+        qInfo() << "           using dc directory: " << psaDcDir;
+        qInfo() << "using psa repo root directory: " << psaRepoRootDir;
+        qInfo() << "    using customer repository: " << psaRepoDir;
+        qInfo() << "                 using branch: " << branchName;
     }
 
     // etc/dc: located under mount-path
     std::optional<QString> mountPath = System::checkForUSBStick(psaDcDir);
     QFileInfo fi;
     if (mountPath.has_value()) {
-        fi.setFile(mountPath.value(), System::getDCFileOnUsbStick(mountPath.value()));
+        // usbDetected = true;
+        // mountPath/etc/dc must exists !
+        // cannot override with commandline parameter --dc-directory
+        if (debug) {
+            qInfo() << "using mount path (USB): " << mountPath.value();
+        }
     } else
     if ((mountPath = System::checkForSDCard(psaDcDir)).has_value()) {
-        fi.setFile(mountPath.value(), System::getDCFileOnSDCard(mountPath.value()));
+        // sdCardDetected = true;
-    } else {
+        // mountPath/etc/dc must exists !
-
+        // cannot override with commandline parameter --dc-directory
         if (debug) {
-            qInfo() << "using customer repository" << psaRepoDir;
+            qInfo() << "using mount path (SD): " << mountPath.value();
         }
+    } else {
+        rootDir = "";
+        mountPath = QDir::cleanPath(psaRepoRootDir + QDir::separator() + psaDcDir);
+        if (debug) {
+            qInfo() << "using as dc-directory" << mountPath.value();
+        }
+    }
 
-        std::unique_ptr<QString> c = internal::dcCandidateToInstall("/etc/dc/");
+    if (debug) {
-        if (c) {
+        qInfo() << "using as mount path: " << mountPath.value();
-            fi.setFile(*c);
+    }
-            if (fi.exists() == false) {
+
-                qCritical() << "dc2c.bin candidate" << *c << "does not exist. STOP.";
+    std::unique_ptr<QString> c = internal::dcCandidateToInstall(rootDir, mountPath.value());
-                return -1;
+    if (c) {
-            }
+        fi.setFile(*c);
-            qInfo() << "dc2c.bin canditate" << fi.absoluteFilePath();
+        if (fi.exists() == false) {
+            qCritical() << "dc2c.bin candidate" << *c << "does not exist. STOP.";
+            return -1;
         }
+        qInfo() << "dc2c.bin canditate" << fi.absoluteFilePath();
     }
 
     if (debug) {
@@ -185,6 +218,9 @@ int main(int argc, char **argv) {
         qInfo() << "dc-version" << Update::dcVersion(fi.absoluteFilePath());
     }
 
+    // only for testing
+    // return 0;
+
     Update u(fi.absoluteFilePath(), libca, debug, noaction);
     u.run();
 

UpdatePTUDevCtrl/main.cpp

@@ -50,25 +50,33 @@
 #endif
 
 /**
- * @mainpage ATBUpdateTool Documentation
+ * @mainpage ATB-Update-Tool Documentation
- * @section intro_sec Introduction
+ * \section intro_sec Introduction
- * TODO.
+ *  The ATB update tool consistes of several binaries, which are executed in
- * @section atbupdate_tool ATBUpdateTool
+ *  order:
- * TODO.
+ *  * \ref ATBUpdateTool
- * @section atbupdate_check ATBUpdateCheck
+ *  * \ref ATBUpdateCheck
- * TODO
+ *  * \ref ATBUpdateGit
- * @section atbupdate_git ATBUpdateGit
+ *  * \ref ATBUpdateSync
- * TODO
+ *  * \ref ATBUpdateOpkg
- * @section atbupdate_sync ATBUpdateSync
+ *  * \ref ATBUpdateDC
- * TODO
+ *  * \ref ATBUpdateJsonFiles
- * @section atbupdate_opkg ATBUpdateOpkg
+ *  * \ref ATBUpdateShow
- * TODO
+ *
- * @section atbupdate_dc ATBUpdateDC
+ *  The binaries are started synchonously as child processes of \ref ATBUpdateTool:
- * TODO
+ *  each binary will finish before the next one is started.
- * @section atbupdate_json_files ATBUpdateJsonFiles
+ *  The output for the child process is captured in \ref ATBUpdateTool, and
- * TODO
+ *  optionally shown in the GUI presemted to the user.
- * @section atbupdate_show ATBUpdateShow
+ *
- * TODO
+ * - \page ATBUpdateTool
+ * - \page ATBUpdateCheck
+ * - \page ATBUpdateGit
+ * - \page ATBUpdateSync
+ * - \page ATBUpdateOpkg
+ * - \page ATBUpdateDC
+ *      Typical call: ./ATBUpdateDC --dc-directory /etc/dc/ --debug true
+ * - \page ATBUpdateJsonFiles
+ * - \page ATBUpdateShow
  */
 
 // argv[1]: file to send to dc

UpdatePTUDevCtrl/work_process_list.cpp

@@ -4,12 +4,12 @@
 #include <limits>
 #include <QDebug>
 
-unsigned WorkList::nextExecIndex() const {
+//unsigned WorkList::nextExecIndex() const {
-    if (m_workList.size() > 0 && m_workListIndex < (m_workList.size() - 1)) {
+//    if (m_workList.size() > 0 && m_workListIndex < (m_workList.size() - 1)) {
-        return m_workListIndex + 1;
+//        return m_workListIndex + 1;
-    }
+//    }
-    return std::numeric_limits<unsigned>::max();
+//    return std::numeric_limits<unsigned>::max();
-}
+//}
 
 bool WorkList::nextExec() const {
     return m_workListIndex < m_workList.size();
@@ -17,12 +17,17 @@ bool WorkList::nextExec() const {
 
 bool WorkList::exec(bool last) {
     if (last == false) {
+        // if not the last entry in the worklist
         if (nextExec()) {
+            // and there is a next entry (a binary) to execute, start the
+            // binary if the specified working directory.
             m_workList[m_workListIndex]->start("/opt/app/tools/atbupdate");
+            // update to point to next entry
             m_workListIndex += 1;
             return true;
         }
     } else {
+        // start the last entry in the worklist
         m_workList.back()->start("/opt/app/tools/atbupdate");
         m_workListIndex = std::numeric_limits<unsigned>::max();
         return true;

UpdatePTUDevCtrl/work_process_list.h

@@ -5,18 +5,42 @@
 #include <memory>
 
 class UpdateCommand;
+
+
+/**
+ * @brief This class is responsible for calling the several binaries
+ * \ref ATBUpdateTool consists of.
+ *
+ * This class maintains a worklist, which conists of entries of type UpdateCommand.
+ *
+ * @see UpdateCommand
+ */
 class WorkList {
-public:
+    /**
+     * @brief Actual worklist of items to be eecuted.
+     */
     std::vector<std::unique_ptr<UpdateCommand>> m_workList;
+public:
     unsigned m_workListIndex{0};
 
     WorkList() = default;
 
+    /**
+     * \brief Put new work item into worklist.
+     *
+     * \tparam arg Work item to be added to worklist.
+     */
     template<typename T>
     void push_back(T&& arg) {
         m_workList.push_back(std::forward<T>(arg));
     }
 
+    /**
+     * \brief Check if worklist is empty.
+     *
+     * \retval true if worklist is empty.
+     * \retval false otherwise.
+     */
     bool empty() const { return m_workList.empty(); }
 
     // move constructor: pass in classes derived from UpdateCommand
@@ -28,10 +52,30 @@ public:
     //  , m_workListIndex(0) {
     //}
 
-    unsigned nextExecIndex() const;
+    ///**
+    // * \brief Put new work item into worklist.
+    // *
+    // */
+    //unsigned nextExecIndex() const;
+
+    /**
+     * \brief Put new work item into worklist.
+     *
+     */
     bool nextExec() const;
+
+    /**
+     * \brief Put new work item into worklist.
+     *
+     * \param last
+     */
     bool exec(bool last=false);
 
+    /**
+     * \brief Get current size of worklist.
+     *
+     * \retval Current size of worklist.
+     */
     unsigned size() { return m_workList.size(); }
 };
 

UpdatePTUDevCtrl/worker.cpp

@@ -429,12 +429,6 @@ void Worker::stopProgressLoop() {
     displayProgressInMainWindow(MainWindow::STOP_PROGRESS_LOOP);
 }
 
-//static std::once_flag once;
-//void Worker::run() {
-    // user should not start the update process several times
-//    std::call_once(once, &Worker::privateUpdate, this);
-//}
-
 bool Worker::isRepositoryCorrupted() {
     QDir customerRepository(m_customerRepository);
     if (customerRepository.exists()) {

UpdatePTUDevCtrl/worker.h

@@ -406,9 +406,6 @@ private:
     hwinf *m_hw = nullptr;
     UPDATE_STEP m_lastFailedUpdateStep = UPDATE_STEP::NONE;
 
-protected:
-    virtual void run();
-
 public:
     UPDATE_STEP lastFailedUpdateStep() const {
         return m_lastFailedUpdateStep;

common/include/commandline_parser.h

@@ -23,6 +23,7 @@ class CommandLineParser : public QCommandLineParser {
     QString m_alwaysDownloadDC;
     QString m_readDCVersion{"false"};
     QString m_dcDir{"etc/dc/"};
+    QString m_debug{"false"};
     qint64 m_ppid;
 
     QCommandLineOption m_repositoryUrlOption;
@@ -43,6 +44,7 @@ class CommandLineParser : public QCommandLineParser {
     QCommandLineOption m_dcDirectoryOption;
     QCommandLineOption m_readDCVersionOption;
     QCommandLineOption m_setPPid;
+    QCommandLineOption m_debugOption;
 
     QCommandLineParser m_parser;
 
@@ -77,5 +79,6 @@ public:
     bool alwaysDownloadDC();
     bool readDCVersion();
     QString dcDir();
+    bool debug();
 };
 #endif // COMMAND_LINE_PARSER_H_INCLUDED

common/include/utils_internal.h

@@ -85,7 +85,7 @@ namespace internal {
     QString branchName();
     bool customerRepoExists();
     std::unique_ptr<QSettings> readSettings(QString const &optionalDirName = "");
-    std::unique_ptr<QString> dcCandidateToInstall(QString const &dcDirectory = "");
+    std::unique_ptr<QString> dcCandidateToInstall(QString const &dcDirectory, QString const &rootDir = "");
 }
 
 #endif // UTILS_INTERNAL_H_INCLUDED

common/src/commandline_parser.cpp

@@ -100,7 +100,12 @@ CommandLineParser::CommandLineParser()
         QCommandLineOption(
             QStringList() << "P" << "set-ppid",
             QCoreApplication::translate("main", "Set pid of parent process."),
-            QCoreApplication::translate("main", "Set pid of parent process."))) {
+            QCoreApplication::translate("main", "Set pid of parent process.")))
+  , m_debugOption(
+        QCommandLineOption(
+            QStringList() << "debug" << "debug",
+            QCoreApplication::translate("main", "Set debug flag."),
+            QCoreApplication::translate("main", "Set debug flag."))) {
 
     configure();
 }
@@ -110,7 +115,7 @@ void CommandLineParser::configure() {
     m_parser.addHelpOption();
     m_parser.addVersionOption();
 
-    m_repositoryUrlOption.setDefaultValue("https://git.mimbach49.de/GerhardHoffmann");
+    m_repositoryUrlOption.setDefaultValue("https://ptu-config.atb-comm.de/ATB/");
     m_parser.addOption(m_repositoryUrlOption);
 
     m_iniFileDirectoryOption.setDefaultValue(QCoreApplication::applicationDirPath());
@@ -163,6 +168,9 @@ void CommandLineParser::configure() {
 
     m_setPPid.setDefaultValue("-1");
     m_parser.addOption(m_setPPid);
+
+    m_debugOption.setDefaultValue("false");
+    m_parser.addOption(m_debugOption);
 }
 
 void CommandLineParser::readSettings() {
@@ -180,7 +188,7 @@ void CommandLineParser::readSettings() {
             for (QString const &key: keys) {
                 QVariant v = settings.value(key);
 
-                //qCritical() << "(" << __func__ << ":" << __LINE__ << ")"
+                // qCritical() << "(" << __func__ << ":" << __LINE__ << ")"
                 //            << key << " -> " << v.toString();
 
                 if (key.contains("repository-url")) {
@@ -227,6 +235,9 @@ void CommandLineParser::readSettings() {
                 } else
                 if (key.contains("read-dc-version")) {
                     m_readDCVersion = (v.toBool() ? "true" : "false");
+                } else
+                if (key.contains("debug")) {
+                    m_debug = (v.toBool() ? "true" : "false");
                 } else {
                     qCritical() << __PRETTY_FUNCTION__
                                 << key << " -> (UNKNOWN) " << v.toString();
@@ -288,6 +299,13 @@ bool CommandLineParser::readDCVersion() {
     return m_readDCVersion == "false" ? false : true;
 }
 
+bool CommandLineParser::debug() {
+    if (m_parser.isSet(m_debugOption)) {
+        m_debug = m_parser.value(m_debugOption);
+    }
+    return m_debug == "false" ? false : true;
+}
+
 QString CommandLineParser::workingDir() {
     if (m_parser.isSet(m_workingDirectoryOption)) {
         m_workingDir = m_parser.value(m_workingDirectoryOption);

common/src/utils_internal.cpp

@@ -62,7 +62,7 @@ QString branchName() {
 }
 
 std::unique_ptr<QSettings> readSettings(QString const &optionalDirName) {
-    std::unique_ptr<QSettings> settings{std::make_unique<QSettings>()};
+    std::unique_ptr<QSettings> settings;
 
     //QString const fileName{settings->applicationName() + ".ini"};
     QString const fileName{"ATBUpdateTool.ini"};
@@ -71,33 +71,17 @@ std::unique_ptr<QSettings> readSettings(QString const &optionalDirName) {
     if (!optionalDirName.isEmpty()) {
         d = QDir{optionalDirName};
         if (d.exists()) { // try to find ini-file under optionalDirname
-            QFileInfo fi{d, optionalDirName};
+            QFileInfo fi{QDir::cleanPath(optionalDirName + QDir::separator() + fileName)};
             if (fi.exists()) {
                 settings.reset(new QSettings(fi.absoluteFilePath(), QSettings::IniFormat));
                 return settings;
             } else {
-                qCritical() << fi.absoluteFilePath() << "not found."
+                qCritical().noquote() << "read" << fileName << ":" << fi.absoluteFilePath() << "not found.";
-                            << "Try" << internal::DEFAULT_INI_DIR;
             }
         } else {
-            qCritical() << optionalDirName << "not found."
+            qCritical().noquote() << optionalDirName << "not found. Try" << internal::DEFAULT_INSTALL_DIR;
-                        << "Try" << internal::DEFAULT_INSTALL_DIR;
         }
     }
-    d = internal::DEFAULT_INI_DIR;
-    if (d.exists()) { // try to find ini-file under /etc/tools/atbupdate
-        QFileInfo fi{d, fileName};
-        if (fi.exists()) {
-            settings.reset(new QSettings(fi.absoluteFilePath(), QSettings::IniFormat));
-            return settings;
-        } else {
-            qCritical() << fi.absoluteFilePath() << "not found."
-                        << "Try" << internal::DEFAULT_INSTALL_DIR;
-        }
-    } else {
-        qCritical() << internal::DEFAULT_INI_DIR << "not found."
-                    << "Try" << internal::DEFAULT_INSTALL_DIR;
-    }
     d = QDir{internal::DEFAULT_INSTALL_DIR};
     if (d.exists()) { // try to find ini-file under /opt/app/tools/atbupdate
         QFileInfo fi{d, fileName};
@@ -105,30 +89,64 @@ std::unique_ptr<QSettings> readSettings(QString const &optionalDirName) {
             settings.reset(new QSettings(fi.absoluteFilePath(), QSettings::IniFormat));
             return settings;
         } else {
-            qCritical() << fi.absoluteFilePath() << "not found.";
+            qCritical().noquote() << "read" << fileName << ":" << fi.absoluteFilePath() << "not found.";
         }
     } else {
-        qCritical() << internal::DEFAULT_INSTALL_DIR << "not found.";
+        qCritical().noquote() << internal::DEFAULT_INSTALL_DIR << "not found.";
     }
 
     return settings;
 }
 
-std::unique_ptr<QString> dcCandidateToInstall(QString const &dcDirectory) {
+/*! \brief Find dc-binary to install.
+ *
+ *  If rootDir is empty, and if dcDirectory is empty as well, use etc/dc in
+ *  custome repository (e,.g. /opt/app/tools/atbupdate/customer_337/etc/dc).
+ *  If dcDirectory is not empty, then use it.
+ *  If rootDir is \b not empty,check if it alreay ends with "/etc/dc/". in this
+ *  case, use rootDir as dcDir. Otherwise, if dcDirectory is empty, use rootDir/etc/dc
+ *  (e,.g. /opt/app/tools/atbupdate/customer_337/etc/dc). If dcDirectory
+ *  is not empty, use roorDir/dcDirectory.
+ *  As last resort, try "/etc/dc".
+ *
+ *  \param[in] dcDirectory directory of device controller binary. Maybe empty.
+ *  \param[in] rootDir root directory for dcDirectory. Might be empty.
+ *  \return name of the found candidate, or null if not found.
+ */
+std::unique_ptr<QString> dcCandidateToInstall(QString const &dcDirectory,
+                                              QString const &rootDir) {
     std::unique_ptr<QString> dcCandidate{nullptr};
 
-    qCritical() << __func__ << __LINE__ << dcDirectory;
+    QDir dcDir;
+
+    if (rootDir.isEmpty()) {
+        if (dcDirectory.isEmpty()) {
+            dcDir = customerRepoDcDir();
+        } else {
+            dcDir = dcDirectory;
+        }
+    } else {
+        if (!rootDir.endsWith("/etc/dc") && !rootDir.endsWith("/etc/dc/")) {
+            if (dcDirectory.isEmpty()) {
+                dcDir = QDir::cleanPath(rootDir + QDir::separator() + "etc/dc/");
+            } else {
+                dcDir = QDir::cleanPath(rootDir + QDir::separator() + dcDirectory);
+            }
+        } else {
+            dcDir = QDir::cleanPath(rootDir + QDir::separator());
+        }
+    }
 
-    QDir dcDir{dcDirectory.isEmpty() ? customerRepoDcDir() : dcDirectory};
     if (dcDir.exists()) {
 
+        qInfo() << "use" << dcDir.absolutePath() << "as directory (containing dc-binary)";
+
         QFileInfoList fileInfoList =
             dcDir.entryInfoList(QStringList("*.bin"),
                                 QDir::Files | QDir::NoDotAndDotDot | QDir::NoSymLinks);
 
         QFileInfo dc2cbin{dcDir.absoluteFilePath("dc2c.bin")};
 
-
         if (dc2cbin.exists()) {
 
             QCryptographicHash md5gen(QCryptographicHash::Md5);
@@ -159,6 +177,12 @@ std::unique_ptr<QString> dcCandidateToInstall(QString const &dcDirectory) {
                 }
             }
         }
+    } else {
+        qCritical() << dcDir.absolutePath() << "does not exist";
+        if (dcDir.absolutePath() != QDir("/etc/dc/").absolutePath()) {
+            qInfo() << __func__ << __LINE__ << "Try /etc/dc/";
+            return dcCandidateToInstall("/etc/dc/", "");
+        }
     }
 
     return dcCandidate;

documentation/atb-update-tool.tex

@@ -1,138 +0,0 @@
-\documentclass[fontsize=11
-pt,a4paper,draft]{scrartcl}[2003/01/01]
-\usepackage[english]{babel}
-\usepackage[T1]{fontenc}
-\usepackage[utf8]{inputenc}
-\usepackage{textcomp}
-\usepackage{blindtext}
-\usepackage{mathpazo}
-\usepackage{amsmath}
-\usepackage{listings}
-\usepackage{minted}
-\usepackage{setspace}
-\usepackage[acronym]{glossaries}
-\usepackage{euler}
-\usepackage[]{mdframed}
-\usepackage{tabularx}
-\usepackage{hyperref}
-\usepackage{pifont}
-\usepackage{float}
-\usepackage{multirow}
-\usepackage{uml}
-\usepackage{tikz,pgfplots}
-\usetikzlibrary{math}
-
-
-\global\mdfdefinestyle{default}{%
-linecolor=black,linewidth=1pt,%
-innertopmargin=20,innerbottommargin=20
-}
-
-\lstset{emph={any-of,all-off},emphstyle=\textbf}
-
-\title{ATB Update Tool(s)}
-
-%\author{Gerhard Hoffmann}
-\date{\today\\\normalsize Version 0.1.0}
-
-% \newacronym{pnd}{PND}{\textbf{p}ay \textbf{and} \textbf{d}isplay machine}
-% \newacronym{psa}{PSA}{pay and display machine}
-
-\newglossaryentry{ISMAS}{%
-    name=ISMAS,
-    description={\textbf{I}ntelligentes \textbf{S}ervice
- 	\textbf{M}anagement und \textbf{A}bbrechnungs\textbf{S}ystem}
-}%
-
-\newglossaryentry{ATBUpdateCheck}{%
-    name=ATBUpdateCheck,
-    description={Tool for checking ISMAS connectivity and for checking
-	if an update-request has been scheduled.}%
-}%
-
-\newglossaryentry{ATBUpdateGit}{%
-    name=ATBUpdateGit,
-    description={}
-}%
-
-\newglossaryentry{ATBUpdateOpkg}{%
-    name=ATBUpdateOpkg,
-    description={}
-}%
-
-\newglossaryentry{ATBUpdateSync}{%
-    name=ATBUpdateSync,
-    description={}
-}%
-
-\newglossaryentry{ATBUpdateShow}{%
-    name=ATBUpdateShow,
-    description={}
-}%
-
-\newglossaryentry{ATBUpdateDC}{%
-    name=ATBUpdateDC,
-    description={}
-}%
-
-\newglossaryentry{ATBUpdateDCConfig}{%
-    name=ATBUpdateDCConfig,
-    description={}
-}%
-
-\makeglossaries
-
-\begin{document}
-\maketitle
-\tableofcontents
-
-
-\section*{History}
-\begin{table}[htbp]
-    \centering
-
-\begin{tabularx}{\textwidth}{|>{\hsize=.15\hsize}c|>{\hsize=.25\hsize}X|>{\hsize
-=.6\hsize}X|}
-        \hline
-        \textbf{Version}     & \textbf{Date}     & \textbf{Comment}     \\
-\hline
-        0.1.0     & \today        &          \\ \hline
-    \end{tabularx}
-\end{table}
-
-\pagebreak
-
-\section{Introduction}
-  
-\section{ATBUpdateCheck}
-\gls{ATBUpdateCheck} is used for two purposes: 
-\begin{enumerate}
-    \item Check \gls{ISMAS} can be reached (network).
-    \item Check if an update has been scheduled.
-\end{enumerate}
-
-\section{ATBUpdateGit}
-\gls{ATBUpdateGit}
-
-\section{ATBUpdateOpkg}
-\gls{ATBUpdateOpkg}
-
-\section{ATBUpdateSync}
-\gls{ATBUpdateSync}
-
-\section{ATBUpdateDCConfig}
-\gls{ATBUpdateDCConfig}
-
-\section{ATBUpdateDC}
-\gls{ATBUpdateDC}
-
-\section{ATBUpdateShow}
-\gls{ATBUpdateShow}
-
-\section{Known issues}
-
-\pagebreak
-% Print the glossary 
-\printglossaries 
-  
-\end{document}

misc/on_update_failure.sh

@@ -0,0 +1,184 @@
+#!/bin/bash
+
+# set -x
+
+#
+#############################################################################
+# Check if the ATBUpdateTool(.service) did not send U0001 (sucess),
+# U0002 (activated) or U0003 (error) to ISMAS, including the case that the
+# tool did not crash or was not killed under other circumstances.
+#
+# This script will be called in the associated atbupdatetool.service (see
+# /lib/systemd/system/atbupdatetool.service).
+#
+###############################################################################
+
+readonly OUT_FILE=/tmp/out.txt
+readonly SCRIPT_NAME=$(basename $0)
+
+if [ -z "$START_DATE" ]
+then
+    START_DATE=$(date +"%Y-%m-%d00:00:00")
+fi
+
+if [ -z "$STOP_DATE" ]
+then
+    STOP_DATE=$(date +"%Y-%m-%d%H:%M:%S")
+fi
+
+echo "EXIT_CODE=$EXIT_CODE"
+echo "SERVICE_RESULT=$SERVICE_RESULT"
+echo "EXIT_STATUS=$EXIT_STATUS"
+echo "START_DATE=$START_DATE"
+echo "STOP_DATE=$STOP_DATE"
+
+
+last_cmd_event () {
+    # output json; look for start of CMD_EVENT; look for }}; extract everything between; finally re-add }}.
+    # could also look for ">>>", but this might change in the future.
+    local json=$(\
+	    journalctl -u atbupdatetool --since="$START_DATE" --until="$STOP_DATE" --output=json-pretty |\
+	    grep "#M=APISM#C=CMD_EVENT#J="                                                              |\
+	    awk '{split($0, a, "#M=APISM#C=CMD_EVENT#J="); print a[2]}'                                 |\
+	    awk '{split($0, a, /\}[\s]*\}/); print a[1]}'                                               |\
+	    tr -d '\\'                                                                                  |\
+	    tail -1)
+    json+="}}"
+    echo "$json"
+}
+
+last_percent_value () {
+    echo $(cat $OUT_FILE | sed -n "s/\(^.*\)\(\"PERCENT\"\\s*:\)\(\\s*[0-9]\+\)\(.*$\)/\3/p" | xargs | awk '{print $NF}')
+}
+
+last_step () {
+    echo $(cat $OUT_FILE | sed -n "s/\(^.*\)\(\"PERCENT\"\\s*:\)\(\\s*[0-9]\+\)\(.*$\)/\1\2\3\4/p" | tail -1 | awk '{split($0, a, ","); print a[8]}' | awk '{split($0, b, " : "); print b[2]}' | tr -d '"\\')
+}
+
+last_step_result () {
+    echo $(cat $OUT_FILE | sed -n "s/\(^.*\)\(\"PERCENT\"\\s*:\)\(\\s*[0-9]\+\)\(.*$\)/\1\2\3\4/p" | tail -1 | awk '{split($0, a, ","); print a[9]}' | awk '{split($0, b, " : "); print b[2]}' | tr -d '"\\')
+}
+
+pid_atbupdatetool () {
+    echo $(cat $OUT_FILE | sed -n "s/\(^.*\)\(ATBUpdateTool\[\)\(\\s*[0-9]\+\)\(\].*$\)/\3/p" | uniq)
+}
+
+last_event () {
+    echo $(cat $OUT_FILE | sed -n "s/\(^.*\)\(\"PERCENT\"\\s*:\)\(\\s*[0-9]\+\)\(.*$\)/\1\2\3\4/p" | tail -1 | awk '{split($0, a, ","); print a[4]}' | awk '{split($0, b, ":"); print b[2]}' | tr -d ' ' | tr -d '"\\') 
+}
+
+sendU0003 () {
+    LAST_CMD_EVENT=$(last_cmd_event)
+    echo "LAST=$LAST_CMD_EVENT"
+    
+    local json_detected=0
+    local temp
+    local x
+
+    if [[ ! -z "$LAST_CMD_EVENT" ]]
+    then
+       temp=$(mktemp -p /tmp)
+       echo "$LAST_CMD_EVENT" > "$temp"
+       x=$(jq .EVENT $temp)
+       if [ $? -eq 0 ]; then
+           json_detected=1
+       fi
+    fi
+
+    if [ $json_detected -eq 1 ]
+    then
+        # local pid=$(jq .EVENT_ID $temp)
+
+	# if json has been detected, use "jq".
+
+        x=$(jq .PARAMETER.PERCENT $temp | tr -d '"')
+        [[ -z "$x" ]] && PERCENT=0 || PERCENT=$x
+
+        x=$(jq .PARAMETER.STEP $temp | tr -d '"')
+        [[ -z "$x" ]] && STEP="unknown" || STEP="$x"
+       
+        x=$(jq .PARAMETER.STEP_RESULT $temp | tr -d '"')
+        [[ -z "$x" ]] && STEP_RESULT="unknown" || STEP_RESULT="$x"
+    
+        x=$(pid_atbupdatetool)
+        [[ -z "$x" ]] && PID=99999 || PID=$x
+    
+        x=$(last_event)
+        [[ -z "$x" ]] && EVENT="unknown" || EVENT="$x"
+    
+    else 
+        # cannot parse valid json. try original journal text file.
+
+        x=$(last_percent_value)
+        [[ -z "$x" ]] && PERCENT=0 || PERCENT=$x
+
+        x=$(last_step)
+        [[ -z "$x" ]] && STEP="unknown" || STEP="$x"
+    
+        x=$(last_step_result)
+        [[ -z "$x" ]] && STEP_RESULT="unknown" || STEP_RESULT="$x"
+    
+        x=$(pid_atbupdatetool)
+        [[ -z "$x" ]] && PID=99999 || PID=$x
+
+        x=$(last_event)
+        [[ -z "$x" ]] && EVENT="unknown" || EVENT="$x"
+    fi
+
+    echo "PERCENT=$PERCENT"
+    echo "STEP=$STEP"
+    echo "STEP_RESULT=$STEP_RESULT"
+    echo "PID=$PID"
+    echo "EVENT=$EVENT"
+
+    # build json to be sent to ISMAS with "U0003"
+
+    CURRENT_DATE=$(date +"%Y-%m-%d %H:%M:%S.000%z")
+    U0003Msg="{\
+        \"REASON\":\"SW_UP\",\
+        \"TIMESTAMP\":\"$CURRENT_DATE\",\
+        \"EVENT_ID\":\"$PID\",\
+        \"EVENT\":\"U0003\",\
+        \"EVENTSTATE\":1,\
+        \"PARAMETER\": {\
+            \"PERCENT\" : $PERCENT,\
+            \"RESULTCODE\" : 99,\
+                    \"STEP\" : \"$1 -> monitored last step: $STEP\",\
+                    \"STEP_RESULT\" : \"$1 -> monitored last step result: $STEP_RESULT\",\
+            \"VERSION\" : \"\"\
+        }\
+    }"
+
+    echo -e "U0003Msg=$U0003Msg"
+
+    (echo "#M=APISM#C=CMD_EVENT#J=$U0003Msg"; sleep 5) | nc localhost 7777
+}
+
+# save journal for the last run of atbupdatetool in $OUT_FILE
+echo $(journalctl -u atbupdatetool --since="$START_DATE" --until=$STOP_DATE) > $OUT_FILE
+
+if [[ "$EXIT_CODE" = "exited" && "$SERVICE_RESULT" = "success" && "$EXIT_STATUS" = "0" ]]
+then
+    # almost normal run; at least there was no crash.	
+    if cat $OUT_FILE | grep -o "U0003" | wc -l; then
+        echo "$SCRIPT_NAME: Failure code U0003 already sent to ISMAS"
+        exit 0
+    fi
+
+    if cat $OUT_FILE | grep -o "U0002" | wc -l; then
+        echo "$SCRIPT_NAME: Success code U0002 already sent to ISMAS"
+        exit 0
+    else
+        sendU0003 "$SCRIPT_NAME: Success code U0002 not sent to ISMAS"
+    fi
+
+    if cat $OUT_FILE | grep -o "U0001" | wc -l; then
+        echo "$SCRIPT_NAME: Success code U0001 already sent to ISMAS"
+        exit 0
+    else
+        sendU0003 "$SCRIPT_NAME: Success code U0001 not sent to ISMAS"
+    fi
+else
+    # something unexpected has happened.
+    sendU0003 "$SCRIPT_NAME: EXIT_CODE=$EXIT_CODE;SERVICE_RESULT=$SERVICE_RESULT;EXIT_STATUS=$EXIT_STATUS"
+fi