Skip to content

filter aggregate metadata in Printer_CartridgeInfo #21523

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Oct 22, 2025
Merged

filter aggregate metadata in Printer_CartridgeInfo #21523

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f0f0781
filter aggregate metadata in Printer_CartridgeInfo
f2cmb Oct 16, 2025
e9243d0
adjust tests
f2cmb Oct 16, 2025
37e102e
add commas for passing Lint tests
f2cmb Oct 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion src/Printer_CartridgeInfo.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -243,9 +243,12 @@ public static function getSpecificValueToDisplay($field, $values, array $options
$printer = new Printer();
if (str_starts_with($field, '_virtual_')) {
$type = preg_match('/_virtual_(.*)_percent/', $field, $matches) ? $matches[1] : '';
$raw_data = $options['raw_data']['Printer_' . $printer->getSearchOptionIDByField('field', $field)] ?? [];
// Filter to keep only numeric keys (actual data entries, not metadata like 'count')
$data_entries = array_filter($raw_data, static fn($key) => is_int($key), ARRAY_FILTER_USE_KEY);
$badges = array_filter(array_map(
static fn($data) => self::createCartridgeInformationBadge($data, $type),
$options['raw_data']['Printer_' . $printer->getSearchOptionIDByField('field', $field)]
$data_entries
));

if ($badges) {
Expand Down
279 changes: 279 additions & 0 deletions tests/functional/Printer_CartridgeInfoTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,279 @@
<?php

/**
* ---------------------------------------------------------------------
*
* GLPI - Gestionnaire Libre de Parc Informatique
*
* http://glpi-project.org
*
* @copyright 2015-2025 Teclib' and contributors.
* @licence https://www.gnu.org/licenses/gpl-3.0.html
*
* ---------------------------------------------------------------------
*
* LICENSE
*
* This file is part of GLPI.
*
* 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 3 of the License, or
* (at your option) any later version.
*
* This program 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 this program. If not, see <https://www.gnu.org/licenses/>.
*
* ---------------------------------------------------------------------
*/

namespace tests\units;

use DbTestCase;

/* Test for inc/printer_cartridgeinfo.class.php */

class Printer_CartridgeInfoTest extends DbTestCase
{
public function testGetSpecificValueToDisplayWithAggregateData()
{
// Create printer
$printers_id = $this->createItem(\Printer::class, [
'name' => 'Test Printer CMYK',
'entities_id' => $this->getTestRootEntity(true),
])->getID();

// Add cartridge info
$cartridge_info = new \Printer_CartridgeInfo();
$cartridge_info->add([
'printers_id' => $printers_id,
'property' => 'tonerblack',
'value' => '71',
]);
$cartridge_info->add([
'printers_id' => $printers_id,
'property' => 'tonercyan',
'value' => '85',
]);

// Simulate search engine raw_data structure with 'count' metadata
$options = [
'raw_data' => [
'Printer_1400' => [
'count' => 2,
0 => [
'property' => 'tonerblack',
'value' => '71',
],
1 => [
'property' => 'tonercyan',
'value' => '85',
],
],
],
];

$result = \Printer_CartridgeInfo::getSpecificValueToDisplay(
'_virtual_toner_percent',
[],
$options
);

// Verify badges are displayed
$this->assertNotEmpty($result);
$this->assertStringContainsString('Black', $result);
$this->assertStringContainsString('Cyan', $result);
$this->assertStringContainsString('71%', $result);
$this->assertStringContainsString('85%', $result);
$this->assertStringContainsString('d-flex flex-wrap', $result);
$this->assertStringContainsString('badge', $result);
}

public function testGetSpecificValueToDisplayWithNoCartridges()
{
$options = [
'raw_data' => [
'Printer_1400' => [
'count' => 0,
],
],
];

$result = \Printer_CartridgeInfo::getSpecificValueToDisplay(
'_virtual_toner_percent',
[],
$options
);

$this->assertTrue(empty($result));
}

public function testGetSpecificValueToDisplayWithTonersAndDrums()
{
$options_toner = [
'raw_data' => [
'Printer_1400' => [
'count' => 2,
0 => ['property' => 'tonerblack', 'value' => '55'],
1 => ['property' => 'tonercyan', 'value' => '78'],
],
],
];

$options_drum = [
'raw_data' => [
'Printer_1401' => [
'count' => 2,
0 => ['property' => 'drumblack', 'value' => '32'],
1 => ['property' => 'drumcyan', 'value' => '45'],
],
],
];

// Test toner column
$result_toner = \Printer_CartridgeInfo::getSpecificValueToDisplay(
'_virtual_toner_percent',
[],
$options_toner
);

$this->assertStringContainsString('55%', $result_toner);
$this->assertStringContainsString('78%', $result_toner);
$this->assertStringNotContainsString('32%', $result_toner);

// Test drum column
$result_drum = \Printer_CartridgeInfo::getSpecificValueToDisplay(
'_virtual_drum_percent',
[],
$options_drum
);

$this->assertStringContainsString('32%', $result_drum);
$this->assertStringContainsString('45%', $result_drum);
$this->assertStringNotContainsString('55%', $result_drum);
}

public function testGetSpecificValueToDisplayWithoutCountMetadata()
{
$options = [
'raw_data' => [
'Printer_1400' => [
0 => ['property' => 'tonerblack', 'value' => '90'],
],
],
];

$result = \Printer_CartridgeInfo::getSpecificValueToDisplay(
'_virtual_toner_percent',
[],
$options
);

$this->assertStringContainsString('90%', $result);
}

public function testGetSpecificValueToDisplayWithCMYK()
{
$options = [
'raw_data' => [
'Printer_1400' => [
'count' => 4,
0 => ['property' => 'tonercyan', 'value' => '85'],
1 => ['property' => 'tonermagenta', 'value' => '62'],
2 => ['property' => 'toneryellow', 'value' => '47'],
3 => ['property' => 'tonerblack', 'value' => '93'],
],
],
];

$result = \Printer_CartridgeInfo::getSpecificValueToDisplay(
'_virtual_toner_percent',
[],
$options
);

// Verify all colors are present
$this->assertStringContainsString('Cyan', $result);
$this->assertStringContainsString('Magenta', $result);
$this->assertStringContainsString('Yellow', $result);
$this->assertStringContainsString('Black', $result);
$this->assertStringContainsString('85%', $result);
$this->assertStringContainsString('62%', $result);
$this->assertStringContainsString('47%', $result);
$this->assertStringContainsString('93%', $result);
}

public function testGetSpecificValueToDisplayWithMissingRawData()
{
$options = [];

$result = \Printer_CartridgeInfo::getSpecificValueToDisplay(
'_virtual_toner_percent',
[],
$options
);

$this->assertTrue(empty($result));
}

public function testGetSpecificValueToDisplayWithSearchEngine()
{
$this->login();

// Create printer with cartridge info
$printer = $this->createItem(\Printer::class, [
'name' => 'Test Printer Search',
'entities_id' => $this->getTestRootEntity(true),
]);

$this->createItem(\Printer_CartridgeInfo::class, [
'printers_id' => $printer->getID(),
'property' => 'tonerblack',
'value' => '65',
]);
$this->createItem(\Printer_CartridgeInfo::class, [
'printers_id' => $printer->getID(),
'property' => 'drumcyan',
'value' => '42',
]);

// Run search with toner and drum columns
$params = [
'criteria' => [
[
'field' => 1, // Name
'searchtype' => 'contains',
'value' => 'Test Printer Search',
],
],
'reset' => 'reset',
];
$params = \Search::manageParams(\Printer::class, $params);
$data = \Search::getDatas(\Printer::class, $params, [1, 1400, 1401]);

// Verify search executed successfully
$this->assertGreaterThan(0, $data['data']['totalcount']);
$this->assertCount(1, $data['data']['rows']);

$row = $data['data']['rows'][0];

// Verify toner column contains the badge
$this->assertArrayHasKey('Printer_1400', $row);
$this->assertArrayHasKey('displayname', $row['Printer_1400']);
$toner_display = $row['Printer_1400']['displayname'];
$this->assertStringContainsString('65%', $toner_display);
$this->assertStringContainsString('Black', $toner_display);

// Verify drum column contains the badge
$this->assertArrayHasKey('Printer_1401', $row);
$this->assertArrayHasKey('displayname', $row['Printer_1401']);
$drum_display = $row['Printer_1401']['displayname'];
$this->assertStringContainsString('42%', $drum_display);
$this->assertStringContainsString('Cyan', $drum_display);
}
}
Loading