firebase-ios-sdk/FirebasePerformance/Tests/Unit/FPRTestUtils.h

// Copyright 2020 Google LLC
//
// Licensed 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.

#import <Foundation/Foundation.h>

#import "FirebasePerformance/Sources/FPRNanoPbUtils.h"
#import "FirebasePerformance/Sources/Timer/FIRTrace+Internal.h"
#import "FirebasePerformance/Sources/Timer/FIRTrace+Private.h"

#import "FirebasePerformance/Sources/Loggers/FPRGDTEvent.h"

#import <GoogleDataTransport/GoogleDataTransport.h>

NS_ASSUME_NONNULL_BEGIN

@interface FPRTestUtils : NSObject

/** Default initializer. */
- (instancetype)init NS_UNAVAILABLE;

/** Provide the NSBundle instance that can to be used for testing. SPM tests will have a different
 * bundle when compared to the default unit test bundle. */
+ (NSBundle *)getBundle;

/** Creates a Performance Trace object. */
+ (FIRTrace *)createRandomTraceWithName:(NSString *)name;

/** Add verbose session to specific Performance Trace object. */
+ (FIRTrace *)addVerboseSessionToTrace:(FIRTrace *)trace;

/** Creates a random Performance Metric Proto object. */
+ (firebase_perf_v1_PerfMetric)createRandomPerfMetric:(NSString *)traceName;

/**
 * Creates a random Performance Metric Proto object, with verbose
 * session ID if it is set as verbose.
 */
+ (firebase_perf_v1_PerfMetric)createVerboseRandomPerfMetric:(NSString *)traceName;

/** Creates a random internal Performance Metric Proto object. */
+ (firebase_perf_v1_PerfMetric)createRandomInternalPerfMetric:(NSString *)traceName;

/** Creates a random network request Performance Metric Proto object. */
+ (firebase_perf_v1_PerfMetric)createRandomNetworkPerfMetric:(NSString *)url;

/** Creates a random gauge Performance Metric Proto object. */
+ (firebase_perf_v1_PerfMetric)createRandomGaugePerfMetric;

/** Creates a random GDTCOREvent object. */
+ (GDTCOREvent *)createRandomTraceGDTEvent:(NSString *)traceName;

/** Creates a random GDTCOREvent object with internal trace event. */
+ (GDTCOREvent *)createRandomInternalTraceGDTEvent:(NSString *)traceName;

/** Creates a random GDTCOREvent object with network event. */
+ (GDTCOREvent *)createRandomNetworkGDTEvent:(NSString *)url;

/** Creates a NSData object by copying the given bytes array and returns the reference.
 *
 * @param pbData The pbData to dedoded as NSData
 * @return A reference to NSData
 */
extern NSData *_Nullable FPRDecodeData(pb_bytes_array_t *_Nonnull pbData);

/** Creates a NSString object by copying the given bytes array and returns the reference.
 *
 * @param pbData The pbData to dedoded as NSString
 * @return A reference to the NSString
 * @note This method may cause heap-buffer overflow
 */
extern NSString *_Nullable FPRDecodeString(pb_bytes_array_t *_Nonnull pbData);

/** Creates a NSDictionary by copying the given bytes from the StringToStringMap object and returns
 * the reference.
 *
 * @param map The reference to a StringToStringMap object to be decoded.
 * @param count The number of entries in the dictionary.
 * @return A reference to the dictionary
 */
extern NSDictionary<NSString *, NSString *> *_Nullable FPRDecodeStringToStringMap(
    StringToStringMap *_Nullable map, NSInteger count);

/** Creates a NSDictionary by copying the given bytes from the StringToNumberMap object and returns
 * the reference.
 *
 * @param map The reference to a StringToNumberMap object to be decoded.
 * @param count The number of entries in the dictionary.
 * @return A reference to the dictionary
 */
extern NSDictionary<NSString *, NSNumber *> *_Nullable FPRDecodeStringToNumberMap(
    StringToNumberMap *_Nullable map, NSInteger count);

@end

NS_ASSUME_NONNULL_END