com.unity.test-framework.performance@0.1.36-preview

## [0.1.36] - 2018-8-27

### ProfilerMarkers now take params as arguments

## [0.1.35] - 2018-8-27

### Measure.Method improvements

Add GC allocation to Measure.Method
Add setup/cleanup for Measure.Method
Move order of calls for Measure.Scope

## [0.1.34] - 2018-8-16

### Obsolete warnings

Author: Unity Technologies

CHANGELOG.md

@@ -1,5 +1,17 @@
 # Changelog
 
+## [0.1.36] - 2018-8-27
+
+### ProfilerMarkers now take params as arguments
+
+## [0.1.35] - 2018-8-27
+
+### Measure.Method improvements
+
+Add GC allocation to Measure.Method
+Add setup/cleanup for Measure.Method
+Move order of calls for Measure.Scope
+
 ## [0.1.34] - 2018-8-16
 
 ### Obsolete warnings

README.md

@@ -11,13 +11,13 @@ YourProject/Packages/manifest.json
 ``` json
 {
     "dependencies": {
-        "com.unity.test-framework.performance": "0.1.34-preview",
+        "com.unity.test-framework.performance": "0.1.36-preview",
         "com.unity.modules.jsonserialize": "1.0.0",
-        "com.unity.modules.unitywebrequestwww": "1.0.0",
+        "com.unity.modules.unitywebrequest": "1.0.0",
         "com.unity.modules.vr": "1.0.0"
       },
       "testables": [
-            "com.unity.test-framework.performance"
+        "com.unity.test-framework.performance"
       ],
       "registry": "https://staging-packages.unity.com"
 }
@@ -97,6 +97,7 @@ In cases where you feel the default values are not ideal you can specify custom
 WarmupCount - how many iterations to run without measuring for warmup
 MeasurementCount - how many measurements to take
 IterationsPerMeasurement - how many iterations per measurement to take
+GC - measures the amount of GC allocations
 
 ```
 [PerformanceTest]
@@ -106,6 +107,7 @@ public void Test()
         .WarmupCount(10)
         .MeasurementCount(10)
         .IterationsPerMeasurement(5)
+        .GC()
         .Run();
 }
 ```

Runtime/Measure.cs

@@ -26,7 +26,7 @@ public static ScopeMeasurement Scope(SampleGroupDefinition sampleGroupDefinition
             return new ScopeMeasurement(sampleGroupDefinition);
         }
 
-        public static ProfilerMeasurement ProfilerMarkers(SampleGroupDefinition[] sampleGroupDefinitions)
+        public static ProfilerMeasurement ProfilerMarkers(params SampleGroupDefinition[] sampleGroupDefinitions)
         {
             return new ProfilerMeasurement(sampleGroupDefinitions);
         }
@@ -65,8 +65,8 @@ public ScopeMeasurement(SampleGroupDefinition sampleGroupDefinition)
 
         public void Dispose()
         {
-            PerformanceTest.Disposables.Remove(this);
             var elapsedTicks = Stopwatch.GetTimestamp() - m_StartTicks;
+            PerformanceTest.Disposables.Remove(this);
             var delta = TimeSpan.FromTicks(elapsedTicks).TotalMilliseconds;
 
             Measure.Custom(m_TimeSampleGroup.Definition,

Runtime/Measurements/FramesMeasurement.cs

@@ -19,7 +19,7 @@ public class FramesMeasurement
         private int m_Warmup = -1;
         private bool m_RecordFrametime = true;
 
-        public FramesMeasurement ProfilerMarkers(SampleGroupDefinition[] profilerDefinitions)
+        public FramesMeasurement ProfilerMarkers(params SampleGroupDefinition[] profilerDefinitions)
         {
             m_ProfilerDefinitions = profilerDefinitions;
             return this;

Runtime/Measurements/MethodMeasurement.cs

@@ -2,6 +2,7 @@
 using System.Collections.Generic;
 using Unity.PerformanceTesting.Runtime;
 using UnityEngine;
+using UnityEngine.Profiling;
 
 
 namespace Unity.PerformanceTesting.Measurements
@@ -15,25 +16,30 @@ public class MethodMeasurement
         private const int k_MaxIterations = 10000;
         private readonly Action m_Action;
         private readonly List<SampleGroup> m_SampleGroups = new List<SampleGroup>();
+        private readonly Recorder m_GCRecorder;
 
+        private Action m_Setup;
+        private Action m_Cleanup;
         private SampleGroupDefinition m_Definition;
         private int m_WarmupCount;
         private int m_MeasurementCount;
         private int m_IterationCount = 1;
+        private bool m_GC;
 
         public MethodMeasurement(Action action)
         {
             m_Action = action;
+            m_GCRecorder = Recorder.Get("GC.Alloc");
         }
 
-        public MethodMeasurement ProfilerMarkers(SampleGroupDefinition[] profilerDefinitions)
+        public MethodMeasurement ProfilerMarkers(params SampleGroupDefinition[] profilerDefinitions)
         {
             if (profilerDefinitions == null) return this;
             AddProfilerMarkers(profilerDefinitions);
             return this;
         }
 
-        private void AddProfilerMarkers(SampleGroupDefinition[] samplesGroup)
+        private void AddProfilerMarkers(params SampleGroupDefinition[] samplesGroup)
         {
             foreach (var sample in samplesGroup)
             {
@@ -82,7 +88,25 @@ public MethodMeasurement MeasurementCount(int count)
             m_MeasurementCount = count;
             return this;
         }
-        
+
+        public MethodMeasurement CleanUp(Action action)
+        {
+            m_Cleanup = action;
+            return this;
+        }
+
+        public MethodMeasurement SetUp(Action action)
+        {
+            m_Setup = action;
+            return this;
+        }
+
+        public MethodMeasurement GC()
+        {
+            m_GC = true;
+            return this;
+        }
+
         public void Run()
         {
             if (m_MeasurementCount > 0)
@@ -91,7 +115,7 @@ public void Run()
                 RunForIterations(m_IterationCount, m_MeasurementCount);
                 return;
             }
-            
+
             var iterations = Probing();
             RunForIterations(iterations, k_MeasurementCount);
         }
@@ -101,15 +125,15 @@ private void RunForIterations(int iterations, int measurements)
             UpdateSampleGroupDefinition();
 
             EnableMarkers();
-            for (int j = 0; j < measurements; j++)
+            for (var j = 0; j < measurements; j++)
             {
                 var executionTime = Time.realtimeSinceStartup;
-                for (var i = 0; i < iterations; i++)
-                {
-                    m_Action.Invoke();
-                }
+
+                ExecuteForIterations(iterations);
+
                 executionTime = (Time.realtimeSinceStartup - executionTime) * 1000f / iterations;
-                Measure.Custom(m_Definition, Utils.ConvertSample(SampleUnit.Millisecond, m_Definition.SampleUnit, executionTime));
+                Measure.Custom(m_Definition,
+                    Utils.ConvertSample(SampleUnit.Millisecond, m_Definition.SampleUnit, executionTime));
             }
 
             DisableAndMeasureMarkers();
@@ -155,8 +179,8 @@ private int Probing()
 
             if (iterations == 1)
             {
-                m_Action.Invoke();
-                m_Action.Invoke();
+                ExecuteAction();
+                ExecuteAction();
 
                 return 1;
             }
@@ -171,7 +195,7 @@ private void Warmup(int iterations)
         {
             for (var i = 0; i < iterations; i++)
             {
-                m_Action.Invoke();
+                ExecuteAction();
             }
         }
 
@@ -182,5 +206,38 @@ private void UpdateSampleGroupDefinition()
                 m_Definition = new SampleGroupDefinition("Time");
             }
         }
+
+        private void ExecuteAction()
+        {
+            if (m_Setup != null) m_Setup.Invoke();
+            m_Action.Invoke();
+            if (m_Cleanup != null) m_Cleanup.Invoke();
+        }
+
+        private void ExecuteForIterations(int iterations)
+        {
+            if (m_GC) StartGCRecorder();
+            for (var i = 0; i < iterations; i++)
+            {
+                ExecuteAction();
+            }
+            if (m_GC) EndGCRecorderAndMeasure(iterations);
+        }
+
+        private void StartGCRecorder()
+        {
+            System.GC.Collect();
+
+            m_GCRecorder.enabled = false;
+            m_GCRecorder.enabled = true;
+        }
+
+        private void EndGCRecorderAndMeasure(int iterations)
+        {
+            m_GCRecorder.enabled = false;
+
+            var definiton = new SampleGroupDefinition(m_Definition.Name + ".GC()", SampleUnit.None);
+            Measure.Custom(definiton, m_GCRecorder.sampleBlockCount / iterations);
+        }
     }
 }

Runtime/PerformanceTest.cs

@@ -23,7 +23,7 @@ public class PerformanceTest
         public List<SampleGroup> SampleGroups = new List<SampleGroup>();
 
         public static PerformanceTest Active { get; private set; }
-        internal static List<IDisposable> Disposables = new List<IDisposable>();
+        internal static List<IDisposable> Disposables = new List<IDisposable>(1024);
 
         public delegate void Callback();
 
@@ -50,13 +50,13 @@ internal static void StartTest(ITest currentTest)
         internal static void EndTest(Test test)
         {
             if (test.IsSuite) return;
-            if(test.FullName != Active.TestName) return;
+            if (test.FullName != Active.TestName) return;
             DisposeMeasurements();
             Active.CalculateStatisticalValues();
             Active.EndTime = Utils.DateToInt(DateTime.Now);
             if (OnTestEnded != null) OnTestEnded();
             Active.LogOutput();
-            
+
             TestContext.Out.WriteLine("##performancetestresult:" + JsonUtility.ToJson(Active));
             Active = null;
         }
@@ -67,6 +67,7 @@ private static void DisposeMeasurements()
             {
                 Disposables[i].Dispose();
             }
+
             Disposables.Clear();
         }
 
@@ -99,7 +100,7 @@ public static void Compare(string oldGroup, string newGroup, float percentage)
             {
                 throw new PerformanceTestException("At least on of the provided sample groups has no values.");
             }
-                
+
             CalculateStatisticalValue(group);
             CalculateStatisticalValue(group2);
 
@@ -115,8 +116,9 @@ public static void Compare(string oldGroup, string newGroup, float percentage)
             else if (group.Definition.IncreaseIsBetter || group2.Definition.IncreaseIsBetter)
             {
                 throw new PerformanceTestException(
-                    string.Format("Sample groups {0} and {1} have incompatible definitions. When comparing, sample groups should have a matching SampleGroupDefinition.IncreaseIsBetter value.",
-                    group.Definition.Name, group2.Definition.Name));
+                    string.Format(
+                        "Sample groups {0} and {1} have incompatible definitions. When comparing, sample groups should have a matching SampleGroupDefinition.IncreaseIsBetter value.",
+                        group.Definition.Name, group2.Definition.Name));
             }
 
             if (diff > percentage)
@@ -187,7 +189,8 @@ public override string ToString()
 
                 if (sampleGroup.Samples.Count == 1)
                 {
-                    logString.AppendFormat(" {0:0.00} {1}", sampleGroup.Samples[0], sampleGroup.Definition.SampleUnit);
+                        logString.AppendFormat(" {0:0.00} {1}", sampleGroup.Samples[0],
+                            sampleGroup.Definition.SampleUnit);
                 }
                 else
                 {

package.json

@@ -1,7 +1,7 @@
 {
 	"name": "com.unity.test-framework.performance",
 	"displayName":"Performance testing API",
-	"version": "0.1.34-preview",
+	"version": "0.1.36-preview",
 	"unity": "2018.2",
 	"description": "Performance testing API.",
 	"keywords": ["performance", "test"],