Files
cacti/tests/Unit/Installer/InstallerMicrotimeDateTest.php
Sean Mancini 96033267cb refactor(tests): reorganize unit tests into domain category folders (#7733)
* refactor(tests): reorganize unit tests into domain category folders

- Consolidate per-advisory GHSA regression tests into Security/ subfolders by vuln class
- Group all 186 test files into domain folders: DataCollection/, Ui/, Core/,
  Database/, Installer/, Scripts/, Security/, Plugin/
- Strip GitHub issue/GHSA numbers from filenames; keep IDs in test descriptions
- Fix all __DIR__ relative paths to match new folder nesting depth
- Update CI workflow path triggers and phpunit XML configs for new file locations
- Update .github/copilot-instructions.md with unit test organization guidelines
- Add tests/vendor/ to .gitignore

* add gaurds

* fix up guard for unit tests

* fix redeclaration of cacti_log in tests

* fix updates to unit tests

* fix test patjhs

* fix: update test __DIR__ paths for reorganized test structure

* fix: conditionally define read_user_setting to prevent redeclaration in tests

* fix: conditionally define functions to prevent redeclaration in tests

- Wrap clean_up_lines, raise_message, cacti_debug_backtrace, and get_debug_prefix
  with function_exists() checks to prevent conflicts when test stubs are loaded
  before lib/functions.php in the same PHP process

* fix: add unit test bootstrap to prevent function redeclaration errors

- Create tests/bootstrap-unit.php to load core libraries before tests
- Ensures lib/functions.php loads before test stubs define stub functions
- Test stubs use function_exists() checks, so they detect pre-loaded functions
- Update phpunit.xml to use bootstrap-unit.php for Unit testsuite
- Fixes 'Cannot redeclare read_user_setting()' errors when tests run in same process

* fix: load test stubs before global.php in unit test bootstrap

- Reorder bootstrap to load CactiStubs.php and UnitStubs.php first
- Ensures stub functions like __() are available when global.php loads
- global.php calls get_cacti_version_text() which needs __() for translations
- Fixes 'Call to undefined function __()' error during bootstrap

* fix: remove function conflicts from test stubs

- Remove stub definitions for functions already in lib/functions.php:
  cacti_sizeof, cacti_log, cacti_strtolower, read_config_option,
  read_user_setting, cacti_count
- Keep translation function stubs (__(), __esc()) needed by global.php
- Update bootstrap to load lib/functions.php after stubs
- This prevents function redeclaration errors while maintaining test isolation

* fix: prevent constant and variable redeclaration in bootstrap

- Remove explicit PHP_TESTING and CACTI_TEST_BOOTSTRAP defines from bootstrap
  (CactiStubs.php now handles this with guards)
- Add guards to CactiStubs.php to prevent redefinition of PHP_TESTING
- Only set CACTI_TEST_BOOTSTRAP env vars if not already set
- Fixes PHP warnings about 'Constant X already defined'

* fix: remove redundant lib/functions.php load from bootstrap

include/global.php already loads lib/functions.php at lines 287-288.
The bootstrap was trying to load it again after global.php, but global.php
needs format_cacti_version() to be available on lines 293-294 to define
CACTI_VERSION and CACTI_VERSION_FULL constants.

Solution: Let global.php handle loading lib/functions.php itself, and don't
load it separately in the bootstrap.

* fix: remove more conflicting function stubs from test helpers

- Remove stubs for functions also defined in lib/functions.php:
  raise_message, clean_up_lines, cacti_debug_backtrace, get_debug_prefix
- Remove POLLER_ID constant stub (defined unconditionally by global.php)
- Keep only translation functions and test-specific helpers
- This prevents function/constant redeclaration errors

* fix: minimize test stubs to only translation functions

Remove ALL helper functions and constants from UnitStubs.php that are:
- Defined in lib/functions.php (raise_message, clean_up_lines, etc.)
- Defined in lib/html_utility.php (srv, set_request_var)
- Defined in global_constants.php (POLLER_VERBOSITY_*, MESSAGE_LEVEL_*)
- Defined in global.php (POLLER_ID)

Keep ONLY translation functions (__(), __esc()) that are:
- Called by global.php during initialization
- Not defined elsewhere
- Required for proper bootstrap sequence

This eliminates all constant and function redeclaration errors.

* fix: remove __esc stub - already defined in global_languages.php

Keep only __() translation function stub, which is needed by global.php
and not defined elsewhere in Cacti core.

* fix: handle no-arg case in __() translation stub

The __() function may be called with just a string and no format arguments.
Previously, vsprintf() would fail with 'arguments array must contain 2 items'.
Now, if no args are provided, return the text as-is.
2026-08-16 19:23:31 -07:00

89 lines
3.8 KiB
PHP

<?php
/*
+-------------------------------------------------------------------------+
| Copyright (C) 2004-2026 The Cacti Group |
| |
| This program 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 2 |
| of the License, or (at your option) any later version. |
+-------------------------------------------------------------------------+
| Cacti: The Complete RRDtool-based Graphing Solution |
+-------------------------------------------------------------------------+
*/
require_once dirname(__DIR__, 2) . '/Helpers/CactiStubs.php';
require_once dirname(__DIR__, 3) . '/include/global.php';
require_once dirname(__DIR__, 3) . '/lib/installer.php';
test('a microtime value without a fractional part is not parseable as U.u', function () {
/*
* Root cause. (string) microtime(true) drops the fraction whenever the
* float lands on a whole second, and 'U.u' rejects the result. Calling
* format() on that false is what aborted the CLI install.
*/
expect(DateTime::createFromFormat('U.u', '1785703138'))->toBeFalse();
});
test('installer parses whole-second microtime values instead of returning false', function () {
$date = Installer::dateFromMicrotime('1785703138');
expect($date)->toBeInstanceOf(DateTime::class)
->and($date->getTimestamp())->toBe(1785703138)
->and($date->format('u'))->toBe('000000');
});
test('installer preserves microseconds when the value carries them', function () {
$date = Installer::dateFromMicrotime('1785703138.123456');
expect($date->getTimestamp())->toBe(1785703138)
->and($date->format('u'))->toBe('123456');
});
test('both timestamps of the completion message survive fraction-less values', function () {
/*
* beginInstall() formats a start and a finish timestamp into one message.
* Either can arrive without a fraction, so exercise the worst case where
* neither is parseable as U.u.
*/
$started = Installer::dateFromMicrotime('1785703138');
$completed = Installer::dateFromMicrotime('1785703200');
$message = __('Installation was started at %s, completed at %s', $started->format('Y-m-d H:i:s'), $completed->format('Y-m-d H:i:s'));
expect($started->getTimestamp())->toBe(1785703138)
->and($completed->getTimestamp())->toBe(1785703200)
->and($message)->toContain($started->format('Y-m-d H:i:s'))
->and($message)->toContain($completed->format('Y-m-d H:i:s'));
});
test('installer falls back to now for values it cannot parse', function () {
/*
* install_started reads as an empty string on a fresh config and as false
* once beginInstall() normalises it. Neither is a timestamp, but the log
* line still has to render.
*/
$before = time();
foreach (['', false, null, 'garbage'] as $value) {
$date = Installer::dateFromMicrotime($value);
expect($date)->toBeInstanceOf(DateTime::class)
->and($date->getTimestamp())->toBeGreaterThanOrEqual($before);
}
});
test('a float landing on a whole second stringifies without a fraction', function () {
// Confirms the failure is reachable from the producer, not just from stored values.
expect((string) 1785703138.0)->toBe('1785703138')
->and(Installer::dateFromMicrotime(1785703138.0)->getTimestamp())->toBe(1785703138);
});
test('no installer code path formats a raw U.u parse result', function () {
// Every caller must route through the guard, or the fatal comes back.
$installer = file_get_contents(dirname(__DIR__, 3) . '/lib/installer.php');
expect(substr_count($installer, "DateTime::createFromFormat('U.u'"))->toBe(1)
->and($installer)->toContain('Installer::dateFromMicrotime(');
});