src/Lucene.Net.TestFramework/Support/StackTraceHelper.cs

/*
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
*/

using System;
using System.Text.RegularExpressions;

#if !FEATURE_STACKTRACE
using System.Diagnostics;
#else
using System.Collections.Generic;
using System.Linq;
#endif

namespace Lucene.Net.Util
{
    /// <summary>
    /// LUCENENET specific class to normalize stack trace behavior between different .NET Framework and .NET Standard 1.x,
    /// which did not support the StackTrace class.
    /// </summary>
    public static class StackTraceHelper
    {
        private static readonly Regex METHOD_NAME_REGEX = new Regex(@"at\s+(?<fullyQualifiedMethod>.*\.(?<method>[\w`]+))\(");

        /// <summary>
        /// Matches the StackTrace for a method name.
        /// <para/>
        /// IMPORTANT: To make the tests pass in release mode, the method(s) named here 
        /// must be decorated with <c>[MethodImpl(MethodImplOptions.NoInlining)]</c>.
        /// </summary>
        // LUCENENET TODO: Check whether no inlining is required in .NET Framework/.NET Standard 2.0 and update documentation/make it conditional throughout the project
        public static bool DoesStackTraceContainMethod(string methodName)
        {
#if FEATURE_STACKTRACE
            IEnumerable<string> allMethods = GetStackTrace(false);
            return allMethods.Contains(methodName);
#else
            StackTrace trace = new StackTrace();
            foreach (var frame in trace.GetFrames())
            {
                if (frame.GetMethod().Name.Equals(methodName, StringComparison.Ordinal))
                {
                    return true;
                }
            }
            return false;
#endif

        }

        /// <summary>
        /// Matches the StackTrace for a particular class (not fully-qualified) and method name.
        /// <para/>
        /// IMPORTANT: To make the tests pass in release mode, the method(s) named here 
        /// must be decorated with <c>[MethodImpl(MethodImplOptions.NoInlining)]</c>.
        /// </summary>
        // LUCENENET TODO: Check whether no inlining is required in .NET Framework/.NET Standard 2.0 and update documentation/make it conditional throughout the project
        public static bool DoesStackTraceContainMethod(string className, string methodName) 
        {
#if FEATURE_STACKTRACE
            IEnumerable<string> allMethods = GetStackTrace(true);
            return allMethods.Any(x => x.Contains(className + '.' + methodName));
#else
            StackTrace trace = new StackTrace();
            foreach (var frame in trace.GetFrames())
            {
                var method = frame.GetMethod();
                if (method.DeclaringType.Name.Equals(className, StringComparison.Ordinal) && method.Name.Equals(methodName, StringComparison.Ordinal))
                {
                    return true;
                }
            }
            return false;
#endif
        }

#if FEATURE_STACKTRACE
        private static IEnumerable<string> GetStackTrace(bool includeFullyQualifiedName)
        {
            var matches =
                Environment.StackTrace
                .Split(new string[] { Environment.NewLine }, StringSplitOptions.RemoveEmptyEntries)
                .Select(line =>
                {
                    var match = METHOD_NAME_REGEX.Match(line);

                    if (!match.Success)
                    {
                        return null;
                    }

                    return includeFullyQualifiedName
                        ? match.Groups["fullyQualifiedMethod"].Value
                        : match.Groups["method"].Value;
                })
                .Where(line => !string.IsNullOrEmpty(line));

            return matches;
        }
#endif
    }
}