Refactor FXIOS-13740 [Unit Tests] Microsurvey Telemetry Tests #29814
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,107 @@ | ||
| // This Source Code Form is subject to the terms of the Mozilla Public | ||
| // License, v. 2.0. If a copy of the MPL was not distributed with this | ||
| // file, You can obtain one at http://mozilla.org/MPL/2.0/ | ||
|
|
||
| import Glean | ||
| import XCTest | ||
| @testable import Client | ||
|
|
||
| final class MicrosurveyTelemetryTests: XCTestCase { | ||
| var mockGleanWrapper: MockGleanWrapper! | ||
|
|
||
| override func setUp() { | ||
| super.setUp() | ||
| mockGleanWrapper = MockGleanWrapper() | ||
| } | ||
|
|
||
| override func tearDown() { | ||
| mockGleanWrapper = nil | ||
| super.tearDown() | ||
| } | ||
|
|
||
| func testRecordEvent_WhenSurveyViewed_ThenGleanIsCalled() throws { | ||
| let subject = createSubject() | ||
| let event = GleanMetrics.Microsurvey.shown | ||
| typealias EventExtrasType = GleanMetrics.Microsurvey.ShownExtra | ||
| let expectedSurveyId = "microsurvey-id" | ||
|
|
||
| subject.surveyViewed(surveyId: expectedSurveyId) | ||
|
|
||
| let savedExtras = try XCTUnwrap(mockGleanWrapper.savedExtras.first as? EventExtrasType) | ||
| let savedMetric = try XCTUnwrap(mockGleanWrapper.savedEvents.first as? EventMetricType<EventExtrasType>) | ||
|
|
||
| XCTAssertEqual(mockGleanWrapper.recordEventCalled, 1) | ||
| XCTAssertEqual(savedExtras.surveyId, "microsurvey-id") | ||
| XCTAssert(savedMetric === event, "Received \(savedMetric) instead of \(event)") | ||
| } | ||
|
|
||
| func testRecordEvent_WhenPrivacyNoticeTapped_ThenGleanIsCalled() throws { | ||
| let subject = createSubject() | ||
| let event = GleanMetrics.Microsurvey.privacyNoticeTapped | ||
| typealias EventExtrasType = GleanMetrics.Microsurvey.PrivacyNoticeTappedExtra | ||
| let expectedSurveyId = "microsurvey-id" | ||
|
|
||
| subject.privacyNoticeTapped(surveyId: expectedSurveyId) | ||
|
|
||
| let savedExtras = try XCTUnwrap(mockGleanWrapper.savedExtras.first as? EventExtrasType) | ||
| let savedMetric = try XCTUnwrap(mockGleanWrapper.savedEvents.first as? EventMetricType<EventExtrasType>) | ||
|
|
||
| XCTAssertEqual(mockGleanWrapper.recordEventCalled, 1) | ||
| XCTAssertEqual(savedExtras.surveyId, expectedSurveyId) | ||
| XCTAssert(savedMetric === event, "Received \(savedMetric) instead of \(event)") | ||
| } | ||
|
|
||
| func testRecordEvent_WhenDismissButtonTapped_ThenGleanIsCalled() throws { | ||
| let subject = createSubject() | ||
| let event = GleanMetrics.Microsurvey.dismissButtonTapped | ||
| typealias EventExtrasType = GleanMetrics.Microsurvey.DismissButtonTappedExtra | ||
| let expectedSurveyId = "microsurvey-id" | ||
|
|
||
| subject.dismissButtonTapped(surveyId: expectedSurveyId) | ||
|
|
||
| let savedExtras = try XCTUnwrap(mockGleanWrapper.savedExtras.first as? EventExtrasType) | ||
| let savedMetric = try XCTUnwrap(mockGleanWrapper.savedEvents.first as? EventMetricType<EventExtrasType>) | ||
|
|
||
| XCTAssertEqual(mockGleanWrapper.recordEventCalled, 1) | ||
| XCTAssertEqual(savedExtras.surveyId, expectedSurveyId) | ||
| XCTAssert(savedMetric === event, "Received \(savedMetric) instead of \(event)") | ||
| } | ||
|
|
||
| func testRecordEvent_WhenUserResponseSubmitted_ThenGleanIsCalled() throws { | ||
| let subject = createSubject() | ||
| let event = GleanMetrics.Microsurvey.submitButtonTapped | ||
| typealias EventExtrasType = GleanMetrics.Microsurvey.SubmitButtonTappedExtra | ||
| let expectedSurveyId = "microsurvey-id" | ||
| let expectedSelection = "Neutral" | ||
|
|
||
| subject.userResponseSubmitted(surveyId: expectedSurveyId, userSelection: expectedSelection) | ||
|
|
||
| let savedExtras = try XCTUnwrap(mockGleanWrapper.savedExtras.first as? EventExtrasType) | ||
| let savedMetric = try XCTUnwrap(mockGleanWrapper.savedEvents.first as? EventMetricType<EventExtrasType>) | ||
|
|
||
| XCTAssertEqual(mockGleanWrapper.recordEventCalled, 1) | ||
| XCTAssertEqual(savedExtras.surveyId, expectedSurveyId) | ||
| XCTAssertEqual(savedExtras.userSelection, expectedSelection) | ||
| XCTAssert(savedMetric === event, "Received \(savedMetric) instead of \(event)") | ||
| } | ||
|
|
||
| func testRecordEvent_WhenConfirmationShown_ThenGleanIsCalled() throws { | ||
| let subject = createSubject() | ||
| let event = GleanMetrics.Microsurvey.confirmationShown | ||
| typealias EventExtrasType = GleanMetrics.Microsurvey.ConfirmationShownExtra | ||
| let expectedSurveyId = "microsurvey-id" | ||
|
|
||
| subject.confirmationShown(surveyId: expectedSurveyId) | ||
|
|
||
| let savedExtras = try XCTUnwrap(mockGleanWrapper.savedExtras.first as? EventExtrasType) | ||
| let savedMetric = try XCTUnwrap(mockGleanWrapper.savedEvents.first as? EventMetricType<EventExtrasType>) | ||
|
|
||
| XCTAssertEqual(mockGleanWrapper.recordEventCalled, 1) | ||
| XCTAssertEqual(savedExtras.surveyId, expectedSurveyId) | ||
| XCTAssert(savedMetric === event, "Received \(savedMetric) instead of \(event)") | ||
|
Contributor
Author
There was a problem hiding this comment. The change here from testing other telemetry structs with the mock is I removed the type comparison as well as the previous debug message. |
||
| } | ||
|
|
||
| private func createSubject() -> MicrosurveyTelemetry { | ||
| return MicrosurveyTelemetry(gleanWrapper: mockGleanWrapper) | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| // This Source Code Form is subject to the terms of the Mozilla Public | ||
| // License, v. 2.0. If a copy of the MPL was not distributed with this | ||
| // file, You can obtain one at http://mozilla.org/MPL/2.0/ | ||
|
|
||
| import Foundation | ||
| @testable import Client | ||
|
|
||
| final class MockMicrosurveyTelemetry: MicrosurveyTelemetryProtocol { | ||
| var surveyViewedCalledCount = 0 | ||
| var privacyNoticeTappedCalledCount = 0 | ||
| var dismissButtonTappedCalledCount = 0 | ||
| var userResponseSubmittedCalledCount = 0 | ||
| var confirmationShownCalledCount = 0 | ||
cyndichin marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| func surveyViewed(surveyId: String) { | ||
| surveyViewedCalledCount += 1 | ||
| } | ||
|
|
||
| func privacyNoticeTapped(surveyId: String) { | ||
| privacyNoticeTappedCalledCount += 1 | ||
| } | ||
|
|
||
| func dismissButtonTapped(surveyId: String) { | ||
| dismissButtonTappedCalledCount += 1 | ||
| } | ||
|
|
||
| func userResponseSubmitted(surveyId: String, userSelection: String) { | ||
| userResponseSubmittedCalledCount += 1 | ||
| } | ||
|
|
||
| func confirmationShown(surveyId: String) { | ||
| confirmationShownCalledCount += 1 | ||
| } | ||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.