Benchmark symlink

Author: scivision

+stdlib/+dotnet/read_symlink.m

@@ -1,9 +1,8 @@
 %% DOTNET.READ_SYMLINK resolve the symbolic links of a filepath
+% .NET >= 6 required
 
 function r = read_symlink(file)
 
-r = "";
-
 try
   h = System.IO.FileInfo(file);
   r = string(h.LinkTarget);
@@ -13,6 +12,7 @@
   end
 catch e
   dotnetException(e)
+  r = "";
 end
 
 end

+stdlib/+sys/read_symlink.m

@@ -9,6 +9,9 @@
   cmd = sprintf('readlink -fn "%s"', file);
 else
   cmd = sprintf('pwsh -c "(Get-Item -Path ''%s'').Target"', file);
+
+  % cmd = sprintf('fsutil reparsepoint query "%s"', file);
+  % worried if searching for "Tag value: Symbolic Link" might be locale dependent
 end
 
 if stdlib.is_symlink(file)

example/BenchmarkIsSymlink.m

@@ -1,12 +1,12 @@
 function [r, s] =  BenchmarkIsSymlinkRun()
-tname = "BenchmarkIsSymlink";
+tname = "BenchmarkSymlink";
 
 %% Exist
-r.same = run_bench(tname + "/bench_exist");
+r.same = run_bench(tname + "/bench_is_symlink_exist");
 s.exist = sampleSummary(r.same);
 disp(sortrows(s.exist, "Median"))
 %% Not Exist
-r.not = run_bench(tname + "/bench_not_exist");
+r.not = run_bench(tname + "/bench_is_symlink_not_exist");
 s.not = sampleSummary(r.not);
 disp(sortrows(s.not, "Median"))
 

example/BenchmarkIsSymlinkRun.m

@@ -0,0 +1,20 @@
+function [r, s] =  BenchmarkReadSymlinkRun()
+tname = "BenchmarkSymlink";
+
+%% Exist
+r.same = run_bench(tname + "/bench_read_symlink_exist");
+s.exist = sampleSummary(r.same);
+disp(sortrows(s.exist, "Median"))
+%% Not Exist
+r.not = run_bench(tname + "/bench_read_symlink_not_exist");
+s.not = sampleSummary(r.not);
+disp(sortrows(s.not, "Median"))
+
+end
+
+
+function result = run_bench(name)
+suite = testsuite(name);
+exp = matlab.perftest.TimeExperiment.limitingSamplingError(MaxSamples=20, RelativeMarginOfError=0.1);
+result = exp.run(suite);
+end

example/BenchmarkReadSymlinkRun.m

@@ -0,0 +1,84 @@
+classdef (SharedTestFixtures={ matlab.unittest.fixtures.PathFixture("..")}) ...
+    BenchmarkSymlink < matlab.perftest.TestCase
+
+properties
+link
+target
+not_exist = tempname()
+end
+
+properties(TestParameter)
+is_backend
+rs_backend
+end
+
+methods (TestParameterDefinition, Static)
+function [is_backend, rs_backend] = setupBackend()
+  is_backend = init_backend('is_symlink');
+  rs_backend = init_backend('read_symlink');
+end
+end
+
+
+methods(TestClassSetup)
+function setup_symlink(tc)
+tc.applyFixture(matlab.unittest.fixtures.WorkingFolderFixture())
+
+tc.link = fullfile(pwd(), 'my.lnk');
+
+tc.target = [mfilename("fullpath") '.m'];
+
+tc.assertTrue(stdlib.create_symlink(tc.target, tc.link))
+end
+end
+
+
+methods (Test, TestTags={'is_symlink'})
+
+function bench_is_symlink_exist(tc, is_backend)
+tc.startMeasuring()
+i = stdlib.is_symlink(tc.link, is_backend);
+tc.stopMeasuring()
+
+tc.verifyClass(i, 'logical')
+tc.verifyTrue(i)
+end
+
+
+function bench_is_symlink_not_exist(tc, is_backend)
+tc.startMeasuring()
+i = stdlib.is_symlink(tc.not_exist, is_backend);
+tc.stopMeasuring()
+
+tc.verifyClass(i, 'logical')
+tc.assertNotEmpty(i)
+tc.verifyFalse(i)
+end
+
+end
+
+
+methods (Test, TestTags={'read_symlink'})
+
+function bench_read_symlink_exist(tc, rs_backend)
+tc.startMeasuring()
+i = stdlib.read_symlink(tc.link, rs_backend);
+tc.stopMeasuring()
+
+tc.verifyClass(i, 'string')
+tc.verifyGreaterThan(strlength(i), 0)
+end
+
+
+function bench_read_symlink_not_exist(tc, rs_backend)
+tc.startMeasuring()
+i = stdlib.read_symlink(tc.not_exist, rs_backend);
+tc.stopMeasuring()
+
+tc.verifyClass(i, 'string')
+tc.verifyEqual(strlength(i), 0)
+end
+
+end
+
+end