Merge pull request #4218 from MerginMaps/feature/independent-test-runs

Feature/independent test runs

Author: gabriel-bolbotina

.github/workflows/linux.yml

@@ -134,11 +134,8 @@ jobs:
           ninja
 
       - name: run tests
-        env:
-          TEST_MERGIN_URL: https://app.dev.merginmaps.com/
-          TEST_API_USERNAME: test_mobileapp
-          TEST_API_PASSWORD: ${{ secrets.TEST_API_PASSWORD }}
-          QT_QPA_PLATFORM: "offscreen"
+        env: 
+          QT_QPA_PLATFORM: "offscreen"  
         run: |
           cd build-mm-db/
           xvfb-run --server-args="-screen 0 640x480x24" ctest --output-on-failure

.github/workflows/macos.yml

@@ -131,10 +131,6 @@ jobs:
           ninja
 
       - name: run tests
-        env:
-          TEST_MERGIN_URL: https://app.dev.merginmaps.com/
-          TEST_API_USERNAME: test_mobileapp2
-          TEST_API_PASSWORD: ${{ secrets.TEST_API_PASSWORD }}
         run: |
           cd build-mm-db/
           ctest --output-on-failure

app/test/testmerginapi.cpp

@@ -100,6 +100,9 @@ void TestMerginApi::initTestCase()
   // Note: projects on the server are deleted in createRemoteProject function when needed
 
   qRegisterMetaType<LocalProject>();
+  // wait for the server to finish up the creation of the new user
+  qDebug() << "Workspace initialized - waiting for server-side setup to complete...";
+  QTest::qWait( 3000 ); // Give server 3 seconds to fully initialize the workspace
 }
 
 void TestMerginApi::cleanupTestCase()
@@ -134,6 +137,7 @@ void TestMerginApi::testListProject()
 
   // project is not available locally, so it has no entry
   QVERIFY( !mApi->localProjectsManager().projectFromMerginName( mWorkspaceName, projectName ).isValid() );
+
 }
 
 void TestMerginApi::testListProjectsByName()
@@ -2145,7 +2149,10 @@ void TestMerginApi::testSelectiveSyncChangeSyncFolder()
     photoDirExtra.mkpath( photoPathClient2 );
 
   // simulate some traffic, let both clients create few photos several times (so that project has longer history)
-  for ( int i : { 1, 2, 3, 4, 5 } )
+  for ( int i :
+        {
+          1, 2, 3, 4, 5
+        } )
   {
     QFile f1( photoPathClient1 + "/" + QString( "photoC1-%1.png" ).arg( i ) );
     f1.open( QIODevice::WriteOnly );
@@ -2367,7 +2374,9 @@ void TestMerginApi::testAutosync()
 
   InputUtils::cpDir( TestUtils::testDataDir() + "/planes", projectdir );
 
-  MapThemesModel mtm; AppSettings as; ActiveLayer al;
+  MapThemesModel mtm;
+  AppSettings as;
+  ActiveLayer al;
   ActiveProject activeProject( as, al, mApi->localProjectsManager() );
 
   mApi->localProjectsManager().addLocalProject( projectdir, projectname );
@@ -2426,8 +2435,17 @@ void TestMerginApi::testOfflineCache()
   QVERIFY( mApi->userAuth()->hasValidToken() );
 
   QSettings cacheCheck;
-  QCOMPARE( cacheCheck.value( "Input/login" ).toString(), ::getenv( "TEST_API_USERNAME" ) );
-  QCOMPARE( cacheCheck.value( "Input/username" ).toString(), ::getenv( "TEST_API_USERNAME" ) );
+  // If we used environment variables, we should check that they match
+  if ( getenv( "TEST_API_USERNAME" ) != nullptr && getenv( "TEST_API_USERNAME" ) != nullptr )
+  {
+    QCOMPARE( cacheCheck.value( "Input/login" ).toString(), getenv( "TEST_API_USERNAME" ) );
+    QCOMPARE( cacheCheck.value( "Input/username" ).toString(), getenv( "TEST_API_USERNAME" ) );
+  }
+  else
+  {
+    QCOMPARE( cacheCheck.value( "Input/login" ).toString(), mApi->userInfo()->username() );
+    QCOMPARE( cacheCheck.value( "Input/username" ).toString(), mApi->userInfo()->username() );
+  }
   QVERIFY( !cacheCheck.value( "Input/email" ).toString().isEmpty() );
 
   MerginApi *extraApi = new MerginApi( *mLocalProjectsExtra, this );

app/test/testutils.cpp

@@ -29,23 +29,34 @@ void TestUtils::merginGetAuthCredentials( MerginApi *api, QString &apiRoot, QStr
   Q_ASSERT( api );
 
   // Test server url needs to be set
-  Q_ASSERT( ::getenv( "TEST_MERGIN_URL" ) );
-
-  apiRoot = ::getenv( "TEST_MERGIN_URL" );
+  if ( ::getenv( "TEST_MERGIN_URL" ) == nullptr )
+  {
+    // if there is none, just default to the dev one
+    apiRoot = QStringLiteral( "https://app.dev.merginmaps.com/" );
+  }
+  else
+  {
+    apiRoot = ::getenv( "TEST_MERGIN_URL" );
+    // let's make sure we do not mess with the public instance
+    Q_ASSERT( apiRoot != MerginApi::sDefaultApiRoot );
+  }
   api->setApiRoot( apiRoot );
   qDebug() << "MERGIN API ROOT:" << apiRoot;
 
-  // let's make sure we do not mess with the public instance
-  Q_ASSERT( apiRoot != MerginApi::sDefaultApiRoot );
-
-  // Test user needs to be set
-  Q_ASSERT( ::getenv( "TEST_API_USERNAME" ) );
-
-  // Test password needs to be set
-  Q_ASSERT( ::getenv( "TEST_API_PASSWORD" ) );
-
-  username = ::getenv( "TEST_API_USERNAME" );
-  password = ::getenv( "TEST_API_PASSWORD" );
+  // test user needs to be set
+  // check if there are environmental variables for the username and the password
+  if ( ::getenv( "TEST_API_USERNAME" ) == nullptr && ::getenv( "TEST_API_PASSWORD" ) == nullptr )
+  {
+    // generate a random email and pasword
+    // create the user on the server
+    // create a workspace for the user
+    generateRandomUser( api, username, password );
+  }
+  else
+  {
+    username = ::getenv( "TEST_API_USERNAME" );
+    password = ::getenv( "TEST_API_PASSWORD" );
+  }
 }
 
 void TestUtils::authorizeUser( MerginApi *api, const QString &username, const QString &password )
@@ -112,14 +123,14 @@ QString TestUtils::generateUsername()
 {
   QDateTime time = QDateTime::currentDateTime();
   QString uniqename = time.toString( QStringLiteral( "ddMMyy-hhmmss-z" ) );
-  return QStringLiteral( "input-%1" ).arg( uniqename );
+  return QStringLiteral( "mobile-%1" ).arg( uniqename );
 }
 
 QString TestUtils::generateEmail()
 {
   QDateTime time = QDateTime::currentDateTime();
   QString uniqename = time.toString( QStringLiteral( "ddMMyy-hhmmss-z" ) );
-  return QStringLiteral( "mergin+autotest+%1@lutraconsulting.co.uk" ).arg( uniqename );
+  return QStringLiteral( "mobile-autotest+%1@lutraconsulting.co.uk" ).arg( uniqename );
 }
 
 QString TestUtils::generatePassword()
@@ -128,6 +139,86 @@ QString TestUtils::generatePassword()
   return QStringLiteral( "_Pass12%1" ).arg( pass );
 }
 
+QString TestUtils::generateWorkspaceName( const QString &username )
+{
+  static const QRegularExpression regex( R"(mobile-autotest(\d{6})-(\d{4})\d{2}-\d{3})" );
+  const QRegularExpressionMatch match = regex.match( username );
+
+  if ( match.hasMatch() )
+  {
+    const QString date = match.captured( 1 ); // Day Month Year
+    const QString time = match.captured( 2 ); // Hour Second
+    return QString( "mmat-%1-%2" ).arg( date, time );
+  }
+  return {};
+}
+
+void TestUtils::generateRandomUser( MerginApi *api, QString &username, QString &password )
+{
+  // generate the test run-specific user details
+  QString email = generateEmail();
+  password = generatePassword();
+  username = email.split( '@' ).first();
+  username.remove( "+" );
+
+  // create the account for the test run user
+  api->clearAuth();
+  QSignalSpy spy( api, &MerginApi::registrationSucceeded );
+  QSignalSpy spy2( api, &MerginApi::registrationFailed );
+  api->registerUser( email, password, true );
+  // check that the account has been created.
+  bool success = spy.wait( TestUtils::LONG_REPLY );
+  if ( !success )
+  {
+    qDebug() << "Failed registration" << spy2.takeFirst();
+    QVERIFY( false );
+  }
+
+  // check that the user can be authorized
+  QSignalSpy spyAuth( api->userAuth(), &MerginUserAuth::authChanged );
+  api->authorize( email, password );
+  QVERIFY( spyAuth.wait( TestUtils::LONG_REPLY * 5 ) );
+
+  // create workspace
+  QSignalSpy wsSpy( api, &MerginApi::workspaceCreated );
+  // create the workspace name
+  QString workspace = generateWorkspaceName( username );
+  api->createWorkspace( workspace );
+  bool workspaceSuccess = wsSpy.wait( TestUtils::LONG_REPLY );
+  QVERIFY( workspaceSuccess );
+  qDebug() << "CREATED NEW WORKSPACE:" << workspace;
+
+  // call userInfo to set active workspace
+  QSignalSpy infoSpy( api, &MerginApi::userInfoReplyFinished );
+  api->getUserInfo();
+  QVERIFY( infoSpy.wait( TestUtils::LONG_REPLY ) );
+  QVERIFY( api->userInfo()->activeWorkspaceId() >= 0 );
+
+  // change the data plan
+  QString workspaceId = QString::number( api->userInfo()->activeWorkspaceId() );
+  QSignalSpy wsStorageSpy( api, &MerginApi::updateWorkspaceService );
+
+  // Create JSON payload to change the data plan
+  QString payload = QString( R"({
+                             "limits_override": {
+                             "storage": %1,
+                             "projects" : %2,
+                             "api_allowed" : true
+                             }
+  })" ).arg( TEST_WORKSPACE_STORAGE_SIZE ).arg( TEST_WORKSPACE_PROJECT_NUMBER );
+
+  api->updateWorkspaceService( workspaceId, payload );
+  bool workspaceStorageModified = wsStorageSpy.wait( TestUtils::LONG_REPLY );
+  if ( workspaceStorageModified )
+  {
+    qDebug() << "Updated the storage limit" << workspace;
+  }
+
+// this needs to be cleared, as the user will be authorized in the test cases.
+  api->clearAuth();
+
+}
+
 QString TestUtils::testDataDir()
 {
   QString dataDir( TEST_DATA_DIR );

app/test/testutils.h

@@ -21,6 +21,8 @@ namespace TestUtils
 {
   const int SHORT_REPLY = 5000;
   const int LONG_REPLY = 90000;
+  const int TEST_WORKSPACE_STORAGE_SIZE = 1 * 1024 * 1024 * 1024; // 1 GB
+  const int TEST_WORKSPACE_PROJECT_NUMBER = 100;
 
   //! authorize user and select the active workspace
   void authorizeUser( MerginApi *api, const QString &username, const QString &password );
@@ -33,15 +35,22 @@ namespace TestUtils
    *  - TEST_MERGIN_URL
    *  - TEST_API_USERNAME
    *  - TEST_API_PASSWORD
+   *  And if not found, generate a test run-specific user
    */
   void merginGetAuthCredentials( MerginApi *api, QString &apiRoot, QString &username, QString &password );
 
   //! Whether we need to auth again
   bool needsToAuthorizeAgain( MerginApi *api, const QString &username );
+  void generateRandomUser( MerginApi *api, QString &username, QString &password );
 
   QString generateUsername();
   QString generateEmail();
   QString generatePassword();
+  /*
+  * Create a workspace name from the generated username
+  * Output: a workspace name: mmat-DayMonthYear-HourMinutes
+  */
+  QString generateWorkspaceName( const QString &username );
 
   QString testDataDir();