[users] Add tests of the file-writing components

src/modules/users/CMakeLists.txt

@@ -41,10 +41,19 @@ calamares_add_plugin( users
 )
 
 calamares_add_test(
-    passwordtest
+    userspasswordtest
     SOURCES
         PasswordTests.cpp
         SetPasswordJob.cpp
     LIBRARIES
         ${CRYPT_LIBRARIES}
 )
+
+calamares_add_test(
+    userstest
+    SOURCES
+        Tests.cpp
+        SetHostNameJob.cpp
+    LIBRARIES
+        Qt5::DBus
+)

src/modules/users/SetHostNameJob.cpp

@@ -58,7 +58,7 @@ SetHostNameJob::prettyStatusMessage() const
     return tr( "Setting hostname %1." ).arg( m_hostname );
 }
 
-static bool
+STATICTEST bool
 setFileHostname( const QString& hostname )
 {
     return !( CalamaresUtils::System::instance()
@@ -66,7 +66,7 @@ setFileHostname( const QString& hostname )
                   .failed() );
 }
 
-static bool
+STATICTEST bool
 writeFileEtcHosts( const QString& hostname )
 {
     // The actual hostname gets substituted in at %1
@@ -83,7 +83,7 @@ ff02::2    ip6-allrouters
                   .failed() );
 }
 
-static void
+STATICTEST void
 setSystemdHostname( const QString& hostname )
 {
     QDBusInterface hostnamed( "org.freedesktop.hostname1",

src/modules/users/Tests.cpp

@@ -0,0 +1,124 @@
+/* === This file is part of Calamares - <https://github.com/calamares> ===
+ *
+ *   Copyright 2020, 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 "SetHostNameJob.h"
+
+// Implementation details
+extern bool setFileHostname( const QString& );
+extern bool writeFileEtcHosts( const QString& );
+extern void setSystemdHostname( const QString& );
+
+#include "GlobalStorage.h"
+#include "JobQueue.h"
+#include "utils/CalamaresUtilsSystem.h"
+#include "utils/Logger.h"
+#include "utils/Yaml.h"
+
+#include <QTemporaryDir>
+#include <QtTest/QtTest>
+
+class UsersTests : public QObject
+{
+    Q_OBJECT
+public:
+    UsersTests();
+    virtual ~UsersTests() {}
+
+private Q_SLOTS:
+    void initTestCase();
+
+    void testEtcHostname();
+    void testEtcHosts();
+
+private:
+    QTemporaryDir m_dir;
+};
+
+UsersTests::UsersTests()
+    : m_dir( QStringLiteral( "/tmp/calamares-usertest" ) )
+{
+    // Would want to do this if the test fails, automatically.
+    //
+    // m_dir.setAutoRemove( false );
+}
+
+void UsersTests::initTestCase()
+{
+    Logger::setupLogLevel( Logger::LOGDEBUG );
+    cDebug() << "Users test started.";
+    cDebug() << "Test dir" << m_dir.path();
+
+    // Ensure we have a system object, expect it to be a "bogus" one
+    CalamaresUtils::System* system = CalamaresUtils::System::instance();
+    QVERIFY( system );
+    QVERIFY( system->doChroot() );
+
+    // Ensure we have a system-wide GlobalStorage with /tmp as root
+    if ( !Calamares::JobQueue::instance() )
+    {
+        cDebug() << "Creating new JobQueue";
+        (void)new Calamares::JobQueue();
+    }
+    Calamares::GlobalStorage* gs
+        = Calamares::JobQueue::instance() ? Calamares::JobQueue::instance()->globalStorage() : nullptr;
+    QVERIFY( gs );
+    gs->insert( "rootMountPoint", m_dir.path() );
+}
+
+void UsersTests::testEtcHostname()
+{
+    cDebug() << "Test dir" << m_dir.path();
+
+    QVERIFY( QFile::exists( m_dir.path() ) );
+    QVERIFY( !QFile::exists( m_dir.filePath( "etc" ) ) );
+
+    // Doesn't create intermediate directories
+    QVERIFY( !setFileHostname( QStringLiteral( "tubophone.calamares.io" ) ) );
+
+    QVERIFY( CalamaresUtils::System::instance()->createTargetDirs( "/etc" ) );
+    QVERIFY( QFile::exists( m_dir.filePath( "etc" ) ) );
+
+    // Does write the file
+    QVERIFY( setFileHostname( QStringLiteral( "tubophone.calamares.io" ) ) );
+    QVERIFY( QFile::exists( m_dir.filePath( "etc/hostname" ) ) );
+
+    // 22 for the test string, above, and 1 for the newline
+    QCOMPARE( QFileInfo( m_dir.filePath("etc/hostname") ).size(), 22 + 1);
+}
+
+void UsersTests::testEtcHosts()
+{
+    // Assume previous tests did their work
+    QVERIFY( QFile::exists( m_dir.path() ) );
+    QVERIFY( QFile::exists( m_dir.filePath( "etc" ) ) );
+
+    QVERIFY( writeFileEtcHosts( QStringLiteral( "tubophone.calamares.io" ) ) );
+    QVERIFY( QFile::exists( m_dir.filePath( "etc/hosts" ) ) );
+    // The skeleton contains %1 which has the hostname substituted in, so we lose two,
+    // and the rest of the blabla is 150 (according to Python)
+    QCOMPARE( QFileInfo( m_dir.filePath("etc/hosts") ).size(), 150 + 22 - 2 );
+}
+
+
+
+QTEST_GUILESS_MAIN( UsersTests )
+
+#include "utils/moc-warnings.h"
+
+#include "Tests.moc"
+