v2.8 - Added suite_calc

Author: dkechag

Changes

@@ -1,5 +1,8 @@
 Revision history for Benchmark-DKbench
 
+2.8     2024-06-24
+        - Added suite_calc.
+
 2.7     2024-04-27
         - Improved calc_scalability, returns a hash.
         - Improved and documented suite_run output.

README.md

@@ -292,6 +292,17 @@ The result hash return looks like this:
       _total => $total_avg_scalability
     );
 
+## `suite_calc`
+
+    my ($stats, $stats_multi, $scal) = suite_calc(\%suite_run_options);
+
+Convenience function that combines 3 calls, [suite\_run](https://metacpan.org/pod/suite_run) with `threads=>1`,
+[suite\_run](https://metacpan.org/pod/suite_run) with `threads=>system_identity(1)` and [calc\_scalability](https://metacpan.org/pod/calc_scalability) with
+the results of those two, returning hashrefs with the results of all three calls.
+
+For single-core systems (or when `system_identity(1)` does not return > 1)
+only `$stats` will be returned;
+
 # CUSTOM BENCHMARKS
 
 Version 2.5 introduced the ability to add custom benchmarks to be run along any
@@ -348,6 +359,14 @@ If you want to do a multi-threaded run as well and then calculate scalability:
 
     my %scal = calc_scalability(\%stats, \%stats_multi);
 
+Or, with a single call via the convenience function [suite\_calc](https://metacpan.org/pod/suite_calc):
+
+    my ($stats, $stats_multi, $scal) = suite_calc({
+        include     => 'custom',
+        extra_bench => { custom1 => [sub {my @a=split(//, 'x'x$_) for 1..10000}] }
+      }
+    );
+
 # NOTES
 
 The benchmark suite was created to compare the performance of various cloud offerings.

lib/Benchmark/DKbench.pm

@@ -38,8 +38,8 @@ use Text::Levenshtein::XS;
 
 my $mono_clock = $^O !~ /win/i || $Time::HiRes::VERSION >= 1.9764;
 
-our $VERSION = '2.7';
-our @EXPORT  = qw(system_identity suite_run calc_scalability);
+our $VERSION = '2.8';
+our @EXPORT  = qw(system_identity suite_run calc_scalability suite_calc);
 our $datadir = dist_dir("Benchmark-DKbench");
 
 =head1 NAME
@@ -360,6 +360,17 @@ The result hash return looks like this:
    _total => $total_avg_scalability
  );
 
+=head2 C<suite_calc>
+
+ my ($stats, $stats_multi, $scal) = suite_calc(\%suite_run_options);
+
+Convenience function that combines 3 calls, L<suite_run> with C<threads=E<gt>1>,
+L<suite_run> with C<threads=E<gt>system_identity(1)> and L<calc_scalability> with
+the results of those two, returning hashrefs with the results of all three calls.
+
+For single-core systems (or when C<system_identity(1)> does not return E<gt> 1)
+only C<$stats> will be returned;
+
 =head1 CUSTOM BENCHMARKS
 
 Version 2.5 introduced the ability to add custom benchmarks to be run along any
@@ -416,6 +427,14 @@ If you want to do a multi-threaded run as well and then calculate scalability:
 
   my %scal = calc_scalability(\%stats, \%stats_multi);
 
+Or, with a single call via the convenience function L<suite_calc>:
+
+  my ($stats, $stats_multi, $scal) = suite_calc({
+      include     => 'custom',
+      extra_bench => { custom1 => [sub {my @a=split(//, 'x'x$_) for 1..10000}] }
+    }
+  );
+
 =head1 NOTES
 
 The benchmark suite was created to compare the performance of various cloud offerings.
@@ -526,6 +545,15 @@ sub system_identity {
     return $ncpu;
 };
 
+sub suite_calc {
+    my $opt    = shift;
+    my %single = suite_run({%$opt, threads => 1});
+    my $cpus   = system_identity(1);
+    return \%single unless $cpus > 1;
+    my %multi  = suite_run({%$opt, threads => $cpus});
+    return \%single, \%multi, {calc_scalability(\%single, \%multi)};
+}
+
 sub suite_run {
     my $opt = shift;
     _init_options($opt);

t/cover.t

@@ -144,4 +144,15 @@ is(system_identity(1), 1, 'System identity');
 
 is(Benchmark::DKbench::benchmark_list(), Benchmark::DKbench::benchmark_list({}), 'benchmark_list');
 
+my @out = suite_calc({include => 'Astro', quick => '1'});
+is(scalar @out, 1, 'Single Core result only');
+
+my $mock2 = Test2::Mock->new(
+    class => 'Benchmark::DKbench',
+    override => [ system_identity => sub {return 2} ]
+);
+
+@out = suite_calc({include => 'Astro', quick => '1'});
+is(scalar @out, 3, 'Multi / Scalability results');
+
 done_testing();

t/simple.t

@@ -23,14 +23,15 @@ diag $std[0];
 if ($threads && $threads > 1) {
     $opt{include} = 'Astro';
     $opt{ver}     = 1;
-    @std = capture {%stats2 = suite_run({%opt, threads=>2})};
+    @std          = capture {%stats2 = suite_run({%opt, threads => 2})};
     diag $std[0];
 } else {
-    %stats2 = %stats1;
+    $stats2{$_} = {%{$stats1{$_}}} for qw/Astro _opt _total/;
     $stats2{_opt}->{threads} = 2;
 }
 
 @std = capture {%scal = calc_scalability(\%stats1, \%stats2)};
+
 like($std[0], qr/scalability/, 'Scalability');
 diag $std[0];