3 namespace Drupal\Tests\Core\Batch;
5 use Drupal\Core\Batch\Percentage;
6 use Drupal\Tests\UnitTestCase;
9 * @coversDefaultClass \Drupal\Core\Batch\Percentage
12 * Tests the Batch helper object to make sure that the rounding works properly
15 class PercentagesTest extends UnitTestCase {
16 protected $testCases = [];
19 * @dataProvider providerTestPercentages
22 public function testPercentages($total, $current, $expected_result) {
23 $actual_result = Percentage::format($total, $current);
24 $this->assertEquals($actual_result, $expected_result, sprintf('The expected the batch api percentage at the state %s/%s is %s%% and got %s%%.', $current, $total, $expected_result, $actual_result));
27 * Provide data for batch unit tests.
30 * An array of data used by the test.
32 public function providerTestPercentages() {
33 // Set up an array of test cases.
35 // array(total, current, expected).
38 // Though we should never encounter a case where the current set is set
39 // 0, if we did, we should get 0%.
41 // 1/3 is closer to 33% than to 34%.
43 // 2/3 is closer to 67% than to 66%.
45 // 1/199 should round up to 1%.
47 // 198/199 should round down to 99%.
49 // 199/200 would have rounded up to 100%, which would give the false
50 // impression of being finished, so we add another digit and should get
53 // The same logic holds for 1/200: we should get 0.5%.
55 // Numbers that come out evenly, such as 50/200, should be forced to have
56 // extra digits for consistency.
58 // Regardless of number of digits we're using, 100% should always just be
61 // 1998/1999 should similarly round down to 99.9%.
63 // 1999/2000 should add another digit and go to 99.95%.
64 [2000, 1999, '99.95'],
65 // 19999/20000 should add yet another digit and go to 99.995%.
66 [20000, 19999, '99.995'],
67 // The next five test cases simulate a batch with a single operation
68 // ('total' equals 1) that takes several steps to complete. Within the
69 // operation, we imagine that there are 501 items to process, and 100 are
70 // completed during each step. The percentages we get back should be
71 // rounded the usual way for the first few passes (i.e., 20%, 40%, etc.),
72 // but for the last pass through, when 500 out of 501 items have been
73 // processed, we do not want to round up to 100%, since that would
74 // erroneously indicate that the processing is complete.
75 ['total' => 1, 'current' => 100 / 501, '20'],
76 ['total' => 1, 'current' => 200 / 501, '40'],
77 ['total' => 1, 'current' => 300 / 501, '60'],
78 ['total' => 1, 'current' => 400 / 501, '80'],
79 ['total' => 1, 'current' => 500 / 501, '99.8'],