From a761bf02807c74fdf36092ecd2172d51a28b145d Mon Sep 17 00:00:00 2001
From: Adriaan de Groot <groot@kde.org>
Date: Fri, 5 Jul 2019 23:21:24 +0200
Subject: [PATCH] [initramfs] Add tests

 - These tests exercise the createTargetFile() logic,
   which is essential for creating a safe initramfs
   configuration snippet.
 - Could be moved into libcalamares instead, since the tests
   are not really initramfs specific.
---
 src/modules/initramfs/CMakeLists.txt | 17 +++++
 src/modules/initramfs/Tests.cpp      | 96 ++++++++++++++++++++++++++++
 src/modules/initramfs/Tests.h        | 39 +++++++++++
 3 files changed, 152 insertions(+)
 create mode 100644 src/modules/initramfs/Tests.cpp
 create mode 100644 src/modules/initramfs/Tests.h

diff --git a/src/modules/initramfs/CMakeLists.txt b/src/modules/initramfs/CMakeLists.txt
index 79bb650c5..c2496b2a1 100644
--- a/src/modules/initramfs/CMakeLists.txt
+++ b/src/modules/initramfs/CMakeLists.txt
@@ -7,3 +7,20 @@ calamares_add_plugin( initramfs
         calamares
     SHARED_LIB
 )
+
+if( ECM_FOUND AND BUILD_TESTING )
+    ecm_add_test(
+            Tests.cpp
+        TEST_NAME
+            initramfstest
+        LINK_LIBRARIES
+            ${CALAMARES_LIBRARIES}
+            calamares
+            calamares_job_initramfs # From above
+            ${YAMLCPP_LIBRARY}
+            Qt5::Core
+            Qt5::Test
+    )
+    set_target_properties( initramfstest PROPERTIES AUTOMOC TRUE )
+    target_include_directories( initramfstest PRIVATE /usr/local/include )
+endif()
diff --git a/src/modules/initramfs/Tests.cpp b/src/modules/initramfs/Tests.cpp
new file mode 100644
index 000000000..936c94097
--- /dev/null
+++ b/src/modules/initramfs/Tests.cpp
@@ -0,0 +1,96 @@
+/* === This file is part of Calamares - <https://github.com/calamares> ===
+ *
+ *   Copyright 2019, Adriaan de Groot <groot@kde.org>
+ *
+ *   Calamares is free software: you can redistribute it and/or modify
+ *   it under the terms of the GNU General Public License as published by
+ *   the Free Software Foundation, either version 3 of the License, or
+ *   (at your option) any later version.
+ *
+ *   Calamares is distributed in the hope that it will be useful,
+ *   but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ *   GNU General Public License for more details.
+ *
+ *   You should have received a copy of the GNU General Public License
+ *   along with Calamares. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#include "Tests.h"
+
+#include "GlobalStorage.h"
+#include "JobQueue.h"
+#include "Settings.h"
+
+#include "utils/CalamaresUtilsSystem.h"
+#include "utils/Logger.h"
+#include "utils/Yaml.h"
+
+#include <QtTest/QtTest>
+
+#include <QFileInfo>
+#include <QStringList>
+
+QTEST_GUILESS_MAIN( InitramfsTests )
+
+InitramfsTests::InitramfsTests()
+{
+}
+
+InitramfsTests::~InitramfsTests()
+{
+}
+
+void
+InitramfsTests::initTestCase()
+{
+    Logger::setupLogLevel( Logger::LOGDEBUG );
+}
+
+static const char contents[] = "UMASK=0077\n";
+static const char confFile[] = "/tmp/calamares-safe-umask";
+
+void InitramfsTests::cleanup()
+{
+    QFile::remove( confFile );
+}
+
+void InitramfsTests::testCreateHostFile()
+{
+    
+    CalamaresUtils::System s( false );  // don't chroot
+    QString path = s.createTargetFile( confFile, QByteArray( contents ) );
+    QVERIFY( !path.isEmpty() );
+    QCOMPARE( path, confFile );  // don't chroot, so path create relative to /
+    QVERIFY( QFile::exists( confFile ) );
+
+    QFileInfo fi( confFile );
+    QVERIFY( fi.exists() );
+    QCOMPARE( fi.size(), sizeof( contents )-1 );  // don't count trailing NUL
+    
+    QFile::remove( confFile );
+}
+
+void InitramfsTests::testCreateTargetFile()
+{
+    static const char short_confFile[] = "/calamares-safe-umask";
+    
+    CalamaresUtils::System s( true );
+    QString path = s.createTargetFile( short_confFile, QByteArray( contents ) );
+    QVERIFY( path.isEmpty() );  // because no rootmountpoint is set
+    
+    Calamares::JobQueue j;
+    j.globalStorage()->insert( "rootMountPoint", "/tmp" );
+    
+    path = s.createTargetFile( short_confFile, QByteArray( contents ) );
+    QVERIFY( path.endsWith( short_confFile ) );  // chroot, so path create relative to 
+    QVERIFY( path.startsWith( "/tmp/" ) );
+    QVERIFY( QFile::exists( path ) );
+
+    QFileInfo fi( path );
+    QVERIFY( fi.exists() );
+    QCOMPARE( fi.size(), sizeof( contents )-1 );  // don't count trailing NUL
+    
+    QFile::remove( path );
+
+}
diff --git a/src/modules/initramfs/Tests.h b/src/modules/initramfs/Tests.h
new file mode 100644
index 000000000..01394d4fa
--- /dev/null
+++ b/src/modules/initramfs/Tests.h
@@ -0,0 +1,39 @@
+/* === This file is part of Calamares - <https://github.com/calamares> ===
+ *
+ *   Copyright 2019, Adriaan de Groot <groot@kde.org>
+ *
+ *   Calamares is free software: you can redistribute it and/or modify
+ *   it under the terms of the GNU General Public License as published by
+ *   the Free Software Foundation, either version 3 of the License, or
+ *   (at your option) any later version.
+ *
+ *   Calamares is distributed in the hope that it will be useful,
+ *   but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ *   GNU General Public License for more details.
+ *
+ *   You should have received a copy of the GNU General Public License
+ *   along with Calamares. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#ifndef TESTS_H
+#define TESTS_H
+
+#include <QObject>
+
+class InitramfsTests : public QObject
+{
+    Q_OBJECT
+public:
+    InitramfsTests();
+    ~InitramfsTests() override;
+
+private Q_SLOTS:
+    void initTestCase();
+    void cleanup();
+    
+    void testCreateHostFile();
+    void testCreateTargetFile();
+};
+
+#endif