Merge pull request #6847 from BOINC/vko_add_client-auth-file_test

[windows][installer] add client_auth.xml creation test

Author: AenBleidd

.github/workflows/windows.yml

@@ -1,6 +1,6 @@
 # This file is part of BOINC.
 # http://boinc.berkeley.edu
-# Copyright (C) 2025 University of California
+# Copyright (C) 2026 University of California
 #
 # BOINC is free software; you can redistribute it and/or modify it
 # under the terms of the GNU Lesser General Public License
@@ -213,7 +213,7 @@ jobs:
       matrix:
         type: [install, upgrade_from_alpha, upgrade_from_stable]
         platform: [x64, arm64]
-        installation_type: [normal, service, test_acct_mgr_login]
+        installation_type: [normal, service, test_acct_mgr_login, test_client_auth_file]
         include:
           - platform: x64
             runner: windows-latest
@@ -223,14 +223,22 @@ jobs:
             argument_list_alpha: "/quiet /qn /l*v alpha.log"
             argument_list_release: "/quiet /qn /l*v release.log"
             argument_list_install: "/quiet /qn /l*v install.log"
+            argument_list_prepare: ""
           - installation_type: service
             argument_list_alpha: "/quiet /qn /norestart /l*v alpha.log ENABLEPROTECTEDAPPLICATIONEXECUTION3=1"
             argument_list_release: "/quiet /qn /norestart /l*v release.log ENABLEPROTECTEDAPPLICATIONEXECUTION3=1"
             argument_list_install: "/quiet /qn /norestart /l*v install.log ENABLEPROTECTEDAPPLICATIONEXECUTION3=1"
+            argument_list_prepare: ""
           - installation_type: test_acct_mgr_login
             argument_list_alpha: "/quiet /qn /l*v alpha.log"
             argument_list_release: "/quiet /qn /l*v release.log"
             argument_list_install: "/quiet /qn /l*v install.log ACCTMGR_LOGIN=test ACCTMGR_PASSWORDHASH=0123456789abcdef"
+            argument_list_prepare: ""
+          - installation_type: test_client_auth_file
+            argument_list_alpha: "/quiet /qn /norestart /l*v alpha.log ENABLEPROTECTEDAPPLICATIONEXECUTION3=1"
+            argument_list_release: "/quiet /qn /norestart /l*v release.log ENABLEPROTECTEDAPPLICATIONEXECUTION3=1"
+            argument_list_install: "/quiet /qn /norestart /l*v install.log ENABLEPROTECTEDAPPLICATIONEXECUTION3=1 BOINC_PROJECT_USERNAME=test_user BOINC_PROJECT_PASSWORD=qwerty123456!@#$%^"
+            argument_list_prepare: '--create-user --username test_user --password "qwerty123456!@#$%^"'
       fail-fast: false
     steps:
       - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8
@@ -266,20 +274,25 @@ jobs:
         run: |
           7z x win_installer.7z
 
+      - name: Prepare installation for further testing
+        if: success() && matrix.argument_list_prepare != ''
+        shell: cmd
+        run: python ./tests/windows_installer_integration_tests_prepare.py ${{matrix.argument_list_prepare}}
+
       - name: Run installation
         if: success()
         shell: powershell
         run: Start-Process "./installer_setup.exe" -ArgumentList "${{matrix.argument_list_install}}" -Wait
 
       - name: Run installation tests
         if: success()
-        run: python ./tests/windows_installer_integration_tests.py --installation-type ${{matrix.installation_type}}
+        run: python ./tests/windows_installer_integration_tests.py --installation-type ${{matrix.installation_type}} --type ${{matrix.type}}
 
       - name: Upload logs on failure
         if: failure()
         uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f
         with:
-          name: windows_installer_test_logs_${{matrix.platform}}_${{matrix.type}}_${{github.event.pull_request.head.sha}}
+          name: windows_installer_test_logs_${{matrix.platform}}_${{matrix.type}}_${{matrix.installation_type}}_${{github.event.pull_request.head.sha}}
           path: |
             install.log
             alpha.log

tests/windows_installer_integration_tests.py

@@ -26,9 +26,10 @@
 import testhelper as testhelper
 
 class IntegrationTests:
-    def __init__(self, installation_type="normal"):
+    def __init__(self, installation_type="normal", test_type="install"):
         self.testhelper = testhelper.TestHelper()
         self.installation_type = installation_type
+        self.test_type = test_type
         self.result = True
         self.result &= self.test_version()
         self.result &= self.test_files_exist()
@@ -39,6 +40,10 @@ def __init__(self, installation_type="normal"):
             self.result &= self.test_service_groups_and_memberships()
         if self.installation_type == "test_acct_mgr_login":
             self.result &= self.test_acct_mgr_login()
+        if self.installation_type == "test_client_auth_file":
+            self.result &= self.test_client_auth_file()
+            if self.test_type == "install":
+                self.result &= self.test_boinc_master_user_only_exists()
 
     def _get_test_executable_file_path(self, filename):
         return pathlib.Path("C:\\Program Files\\BOINC\\") / filename
@@ -146,6 +151,12 @@ def test_service_users_exist(self):
         ts.expect_true(self._check_user_exists("boinc_project"), "Test 'boinc_project' user exists")
         return ts.result()
 
+    def test_boinc_master_user_only_exists(self):
+        ts = testset.TestSet("Test 'boinc_master' user only exists")
+        ts.expect_true(self._check_user_exists("boinc_master"), "Test 'boinc_master' user exists")
+        ts.expect_false(self._check_user_exists("boinc_project"), "Test 'boinc_project' user does not exist")
+        return ts.result()
+
     def test_service_groups_and_memberships(self):
         ts = testset.TestSet("Test BOINC service groups and memberships")
         ts.expect_true(self._check_group_exists("boinc_admins"), "Test 'boinc_admins' group exists")
@@ -186,16 +197,57 @@ def test_acct_mgr_login(self):
 
         return ts.result()
 
+    def test_client_auth_file(self):
+        ts = testset.TestSet("Test client auth file")
+        client_auth_file = self._get_test_data_file_path("client_auth.xml")
+        ts.expect_true(os.path.exists(client_auth_file), "Test 'client_auth.xml' file exists in 'C:\\ProgramData\\BOINC\\'")
+
+        if os.path.exists(client_auth_file):
+            try:
+                tree = ET.parse(client_auth_file)
+                root = tree.getroot()
+
+                ts.expect_equal("client_authorization", root.tag, "Test root element is 'client_authorization'")
+
+                boinc_project_element = root.find("boinc_project")
+                ts.expect_true(boinc_project_element is not None, "Test 'boinc_project' element exists")
+
+                if boinc_project_element is not None:
+                    username_element = boinc_project_element.find("username")
+                    password_element = boinc_project_element.find("password")
+
+                    ts.expect_true(username_element is not None, "Test 'username' element exists")
+                    ts.expect_true(password_element is not None, "Test 'password' element exists")
+
+                    if username_element is not None:
+                        ts.expect_equal("test_user", username_element.text, "Test 'username' element contains 'test_user'")
+
+                    if password_element is not None:
+                        ts.expect_equal("cXdlcnR5MTIzNDU2IUAjJCVe", password_element.text.strip(), "Test 'password' element contains 'cXdlcnR5MTIzNDU2IUAjJCVe'")
+
+            except ET.ParseError as e:
+                ts.expect_true(False, f"Test XML file is well-formed (Parse error: {e})")
+            except Exception as e:
+                ts.expect_true(False, f"Test XML file can be processed (Error: {e})")
+
+        return ts.result()
+
 if __name__ == "__main__":
     parser = argparse.ArgumentParser(description="BOINC Windows Installer Integration Tests")
     parser.add_argument(
         "--installation-type",
         type=str,
         default="normal",
-        help="Installation type (normal or service), default is 'normal'"
+        help="Installation type: 'normal' (default), 'service', 'test_acct_mgr_login', or 'test_client_auth_file'"
+    )
+    parser.add_argument(
+        "--type",
+        type=str,
+        default="install",
+        help="Test type: 'install' (default) or 'upgrade_from_alpha' or 'upgrade_from_stable'"
     )
     args = parser.parse_args()
 
-    if not IntegrationTests(installation_type=args.installation_type).result:
+    if not IntegrationTests(installation_type=args.installation_type, test_type=args.type).result:
         sys.exit(1)
     sys.exit(0)

tests/windows_installer_integration_tests_prepare.py

@@ -0,0 +1,115 @@
+# This file is part of BOINC.
+# https://boinc.berkeley.edu
+# Copyright (C) 2026 University of California
+#
+# BOINC is free software; you can redistribute it and/or modify it
+# under the terms of the GNU Lesser General Public License
+# as published by the Free Software Foundation,
+# either version 3 of the License, or (at your option) any later version.
+#
+# BOINC 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 Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with BOINC.  If not, see <http://www.gnu.org/licenses/>.
+
+"""
+Windows Installer Integration Tests Preparation Script
+
+This script prepares the Windows environment for installer integration tests.
+Currently supports creating test users on Windows.
+"""
+
+import argparse
+import platform
+import subprocess
+import sys
+
+
+def check_windows():
+    """Verify that the script is running on Windows."""
+    if platform.system() != 'Windows':
+        print("Error: This script must be run on Windows.", file=sys.stderr)
+        sys.exit(1)
+
+
+def create_windows_user(username, password):
+    """
+    Create a new Windows user account.
+
+    Args:
+        username: The username for the new account
+        password: The password for the new account
+
+    Returns:
+        bool: True if user was created successfully, False otherwise
+    """
+    try:
+        # Use net user command to create a new local user account
+        cmd = ['net', 'user', username, password, '/add', '/y']
+        result = subprocess.run(
+            cmd,
+            capture_output=True,
+            text=True,
+            check=False
+        )
+
+        if result.returncode == 0:
+            print(f"Successfully created user: {username}")
+            return True
+        else:
+            error_msg = result.stderr.strip() or result.stdout.strip() or "Unknown error occurred"
+            print(f"Error creating user: {error_msg}", file=sys.stderr)
+            return False
+
+    except Exception as e:
+        print(f"Exception while creating user: {e}", file=sys.stderr)
+        return False
+
+
+def main():
+    """Main entry point for the script."""
+    parser = argparse.ArgumentParser(
+        description='Prepare Windows environment for installer integration tests'
+    )
+
+    parser.add_argument(
+        '--create-user',
+        action='store_true',
+        help='Create a new Windows user account'
+    )
+
+    parser.add_argument(
+        '--username',
+        type=str,
+        help='Username for the new account (required with --create-user)'
+    )
+
+    parser.add_argument(
+        '--password',
+        type=str,
+        help='Password for the new account (required with --create-user)'
+    )
+
+    args = parser.parse_args()
+
+    # Check if running on Windows
+    check_windows()
+
+    # Validate arguments
+    if args.create_user:
+        if not args.username or not args.password:
+            parser.error('--create-user requires both --username and --password')
+
+        # Create the user
+        success = create_windows_user(args.username, args.password)
+        sys.exit(0 if success else 1)
+    else:
+        parser.print_help()
+        sys.exit(0)
+
+
+if __name__ == '__main__':
+    main()