blob: 5013dba03b362df0206225dfd4a3277654dc20d7 [file] [log] [blame]
// Copyright (c) 2017 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "chrome/browser/chromeos/login/enrollment/enrollment_screen.h"
#include "base/bind.h"
#include "base/callback.h"
#include "base/command_line.h"
#include "base/test/scoped_mock_time_message_loop_task_runner.h"
#include "base/test/scoped_task_environment.h"
#include "base/threading/thread_task_runner_handle.h"
#include "chrome/browser/chromeos/login/enrollment/enterprise_enrollment_helper.h"
#include "chrome/browser/chromeos/login/enrollment/enterprise_enrollment_helper_mock.h"
#include "chrome/browser/chromeos/login/enrollment/mock_enrollment_screen.h"
#include "chrome/browser/chromeos/login/screens/mock_base_screen_delegate.h"
#include "chrome/browser/chromeos/policy/device_cloud_policy_manager_chromeos.h"
#include "chrome/browser/chromeos/policy/enrollment_config.h"
#include "chrome/browser/chromeos/policy/enrollment_status_chromeos.h"
#include "chrome/browser/chromeos/settings/stub_install_attributes.h"
#include "chrome/test/base/testing_browser_process.h"
#include "chromeos/chromeos_switches.h"
#include "chromeos/dbus/dbus_thread_manager.h"
#include "testing/gtest/include/gtest/gtest.h"
using testing::_;
using testing::AnyNumber;
using testing::Invoke;
namespace chromeos {
class EnrollmentScreenUnitTest : public testing::Test {
public:
EnrollmentScreenUnitTest() = default;
// Creates the EnrollmentScreen and sets required parameters.
virtual void SetUpEnrollmentScreen() {
enrollment_screen_.reset(
new EnrollmentScreen(&mock_delegate_, &mock_view_));
enrollment_screen_->SetEnrollmentConfig(enrollment_config_);
}
// Fast forwards time by the specified amount.
void FastForwardTime(base::TimeDelta time) {
runner_.task_runner()->FastForwardBy(time);
}
MockBaseScreenDelegate* GetBaseScreenDelegate() { return &mock_delegate_; }
MockEnrollmentScreenView* GetMockScreenView() { return &mock_view_; }
// testing::Test:
void SetUp() override {
// Initialize the thread manager.
DBusThreadManager::Initialize();
}
void TearDown() override {
TestingBrowserProcess::GetGlobal()->SetShuttingDown(true);
DBusThreadManager::Shutdown();
}
protected:
std::unique_ptr<EnrollmentScreen> enrollment_screen_;
policy::EnrollmentConfig enrollment_config_;
private:
base::test::ScopedTaskEnvironment scoped_task_environment_;
// Replace main thread's task runner with a mock for duration of test.
base::ScopedMockTimeMessageLoopTaskRunner runner_;
ScopedStubInstallAttributes test_install_attributes_;
// Objects required by the EnrollmentScreen that can be re-used.
MockBaseScreenDelegate mock_delegate_;
MockEnrollmentScreenView mock_view_;
DISALLOW_COPY_AND_ASSIGN(EnrollmentScreenUnitTest);
};
class ZeroTouchEnrollmentScreenUnitTest : public EnrollmentScreenUnitTest {
public:
ZeroTouchEnrollmentScreenUnitTest() = default;
enum AttestationEnrollmentStatus {
SUCCESS,
DEVICE_NOT_SETUP_FOR_ZERO_TOUCH,
DMSERVER_ERROR
};
// Closure passed to EnterpriseEnrollmentHelper::SetupEnrollmentHelperMock
// which creates the EnterpriseEnrollmentHelperMock object that will
// eventually be tied to the EnrollmentScreen. It also sets up the
// appropriate expectations for testing with the Google Mock framework.
// The template parameter should_enroll indicates whether or not
// the EnterpriseEnrollmentHelper should be mocked to successfully enroll.
template <AttestationEnrollmentStatus status>
static EnterpriseEnrollmentHelper* MockEnrollmentHelperCreator(
EnterpriseEnrollmentHelper::EnrollmentStatusConsumer* status_consumer,
const policy::EnrollmentConfig& enrollment_config,
const std::string& enrolling_user_domain) {
EnterpriseEnrollmentHelperMock* mock =
new EnterpriseEnrollmentHelperMock(status_consumer);
if (status == SUCCESS) {
// Define behavior of EnrollUsingAttestation to successfully enroll.
EXPECT_CALL(*mock, EnrollUsingAttestation())
.Times(AnyNumber())
.WillRepeatedly(Invoke([mock]() {
static_cast<EnrollmentScreen*>(mock->status_consumer())
->ShowEnrollmentStatusOnSuccess();
}));
} else {
// Define behavior of EnrollUsingAttestation to fail to enroll.
const policy::EnrollmentStatus enrollment_status =
policy::EnrollmentStatus::ForRegistrationError(
status == DEVICE_NOT_SETUP_FOR_ZERO_TOUCH
? policy::DeviceManagementStatus::
DM_STATUS_SERVICE_DEVICE_NOT_FOUND
: policy::DeviceManagementStatus::
DM_STATUS_TEMPORARY_UNAVAILABLE);
EXPECT_CALL(*mock, EnrollUsingAttestation())
.Times(AnyNumber())
.WillRepeatedly(Invoke([mock, enrollment_status]() {
mock->status_consumer()->OnEnrollmentError(enrollment_status);
}));
}
// Define behavior of ClearAuth to only run the callback it is given.
EXPECT_CALL(*mock, ClearAuth(_))
.Times(AnyNumber())
.WillRepeatedly(Invoke(
[](const base::RepeatingClosure& callback) { callback.Run(); }));
return mock;
}
void SetUpEnrollmentScreen() override {
enrollment_config_.mode =
policy::EnrollmentConfig::MODE_ATTESTATION_LOCAL_FORCED;
enrollment_config_.auth_mechanism =
policy::EnrollmentConfig::AUTH_MECHANISM_ATTESTATION;
EnrollmentScreenUnitTest::SetUpEnrollmentScreen();
}
virtual void SetUpEnrollmentScreenForFallback() {
enrollment_config_.mode = policy::EnrollmentConfig::MODE_ATTESTATION;
enrollment_config_.auth_mechanism =
policy::EnrollmentConfig::AUTH_MECHANISM_BEST_AVAILABLE;
EnrollmentScreenUnitTest::SetUpEnrollmentScreen();
}
// testing::Test:
void SetUp() override {
EnrollmentScreenUnitTest::SetUp();
// Configure the browser to use Hands-Off Enrollment.
base::CommandLine::ForCurrentProcess()->AppendSwitchASCII(
switches::kEnterpriseEnableZeroTouchEnrollment, "hands-off");
}
void TestRetry() {
// Define behavior of EnterpriseEnrollmentHelperMock to always fail
// enrollment.
EnterpriseEnrollmentHelper::SetupEnrollmentHelperMock(
&ZeroTouchEnrollmentScreenUnitTest::MockEnrollmentHelperCreator<
DMSERVER_ERROR>);
SetUpEnrollmentScreen();
// Remove jitter to enable deterministic testing.
enrollment_screen_->retry_policy_.jitter_factor = 0;
// Start zero-touch enrollment.
enrollment_screen_->Show();
// Fast forward time by 1 minute.
FastForwardTime(base::TimeDelta::FromMinutes(1));
// Check that we have retried 4 times.
EXPECT_EQ(enrollment_screen_->num_retries_, 4);
}
void TestFinishEnrollmentFlow() {
// Define behavior of EnterpriseEnrollmentHelperMock to successfully enroll.
EnterpriseEnrollmentHelper::SetupEnrollmentHelperMock(
&ZeroTouchEnrollmentScreenUnitTest::MockEnrollmentHelperCreator<
SUCCESS>);
SetUpEnrollmentScreen();
// Set up expectation for BaseScreenDelegate::OnExit to be called
// with BaseScreenDelegate::ENTERPRISE_ENROLLMENT_COMPLETED
// This is how we check that the code finishes and cleanly exits
// the enterprise enrollment flow.
EXPECT_CALL(*GetBaseScreenDelegate(),
OnExit(ScreenExitCode::ENTERPRISE_ENROLLMENT_COMPLETED))
.Times(1);
// Start zero-touch enrollment.
enrollment_screen_->Show();
}
void TestFallback() {
// Define behavior of EnterpriseEnrollmentHelperMock to fail
// attestation-based enrollment.
EnterpriseEnrollmentHelper::SetupEnrollmentHelperMock(
&ZeroTouchEnrollmentScreenUnitTest::MockEnrollmentHelperCreator<
DEVICE_NOT_SETUP_FOR_ZERO_TOUCH>);
SetUpEnrollmentScreenForFallback();
// Once we fallback we show a sign in screen for manual enrollment.
EXPECT_CALL(*GetMockScreenView(), ShowSigninScreen()).Times(1);
// Start enrollment.
enrollment_screen_->Show();
}
private:
DISALLOW_COPY_AND_ASSIGN(ZeroTouchEnrollmentScreenUnitTest);
};
TEST_F(ZeroTouchEnrollmentScreenUnitTest, FinishEnrollmentFlow) {
TestFinishEnrollmentFlow();
}
TEST_F(ZeroTouchEnrollmentScreenUnitTest, Fallback) {
TestFallback();
}
TEST_F(ZeroTouchEnrollmentScreenUnitTest, Retry) {
TestRetry();
}
TEST_F(ZeroTouchEnrollmentScreenUnitTest, DoNotRetryOnTopOfUser) {
// Define behavior of EnterpriseEnrollmentHelperMock to always fail
// enrollment.
EnterpriseEnrollmentHelper::SetupEnrollmentHelperMock(
&ZeroTouchEnrollmentScreenUnitTest::MockEnrollmentHelperCreator<
DMSERVER_ERROR>);
SetUpEnrollmentScreen();
// Remove jitter to enable deterministic testing.
enrollment_screen_->retry_policy_.jitter_factor = 0;
// Start zero-touch enrollment.
enrollment_screen_->Show();
// Schedule user retry button click after 30 sec.
base::ThreadTaskRunnerHandle::Get()->PostDelayedTask(
FROM_HERE,
base::BindOnce(&EnrollmentScreen::OnRetry,
enrollment_screen_->weak_ptr_factory_.GetWeakPtr()),
base::TimeDelta::FromSeconds(30));
// Fast forward time by 1 minute.
FastForwardTime(base::TimeDelta::FromMinutes(1));
// Check that the number of retries is still 4.
EXPECT_EQ(enrollment_screen_->num_retries_, 4);
}
TEST_F(ZeroTouchEnrollmentScreenUnitTest, DoNotRetryAfterSuccess) {
// Define behavior of EnterpriseEnrollmentHelperMock to successfully enroll.
EnterpriseEnrollmentHelper::SetupEnrollmentHelperMock(
&ZeroTouchEnrollmentScreenUnitTest::MockEnrollmentHelperCreator<SUCCESS>);
SetUpEnrollmentScreen();
// Start zero-touch enrollment.
enrollment_screen_->Show();
// Fast forward time by 1 minute.
FastForwardTime(base::TimeDelta::FromMinutes(1));
// Check that we do not retry.
EXPECT_EQ(enrollment_screen_->num_retries_, 0);
}
/*
* We base these tests off ZeroTouchEnrollmenScreenUnitTest for two reasons:
* 1. We want to check that some same tests pass in both classes
* 2. We want to leverage Zero-Touch Hands Off to test for proper completions
*/
class AutomaticEnrollmentScreenUnitTest
: public ZeroTouchEnrollmentScreenUnitTest,
public ::testing::WithParamInterface<policy::EnrollmentConfig::Mode> {
public:
AutomaticEnrollmentScreenUnitTest() = default;
void SetUpEnrollmentScreen() override {
enrollment_config_.mode = GetParam();
enrollment_config_.auth_mechanism =
policy::EnrollmentConfig::AUTH_MECHANISM_BEST_AVAILABLE;
EnrollmentScreenUnitTest::SetUpEnrollmentScreen();
}
void SetUpEnrollmentScreenForFallback() override {
// Automatic re-enrollment is always setup for fallback.
SetUpEnrollmentScreen();
}
private:
DISALLOW_COPY_AND_ASSIGN(AutomaticEnrollmentScreenUnitTest);
};
TEST_P(AutomaticEnrollmentScreenUnitTest, ShowErrorPanel) {
// We use Zero-Touch's test for retries as a way to know that there was
// an error pane with a Retry button displayed to the user when we encounter
// a DMServer error that is not that the device isn't setup for Auto RE.
TestRetry();
}
TEST_P(AutomaticEnrollmentScreenUnitTest, FinishEnrollmentFlow) {
TestFinishEnrollmentFlow();
}
TEST_P(AutomaticEnrollmentScreenUnitTest, Fallback) {
TestFallback();
}
class MultiLicenseEnrollmentScreenUnitTest : public EnrollmentScreenUnitTest {
public:
MultiLicenseEnrollmentScreenUnitTest() = default;
void SetUpEnrollmentScreen() override {
enrollment_config_.mode = policy::EnrollmentConfig::MODE_MANUAL;
enrollment_config_.auth_mechanism =
policy::EnrollmentConfig::AUTH_MECHANISM_INTERACTIVE;
EnrollmentScreenUnitTest::SetUpEnrollmentScreen();
}
static EnterpriseEnrollmentHelper* MockEnrollmentHelperCreator(
EnterpriseEnrollmentHelper::EnrollmentStatusConsumer* status_consumer,
const policy::EnrollmentConfig& enrollment_config,
const std::string& enrolling_user_domain) {
EnterpriseEnrollmentHelperMock* mock =
new EnterpriseEnrollmentHelperMock(status_consumer);
EXPECT_CALL(*mock, EnrollUsingAuthCode(_, _))
.Times(AnyNumber())
.WillRepeatedly(Invoke([mock](const std::string&, bool) {
EnrollmentLicenseMap licenses;
static_cast<EnrollmentScreen*>(mock->status_consumer())
->OnMultipleLicensesAvailable(licenses);
}));
EXPECT_CALL(*mock, UseLicenseType(::policy::LicenseType::ANNUAL)).Times(1);
return mock;
}
private:
DISALLOW_COPY_AND_ASSIGN(MultiLicenseEnrollmentScreenUnitTest);
};
// Sign in and check that selected license type is propagated correctly.
TEST_F(MultiLicenseEnrollmentScreenUnitTest, TestLicenseSelection) {
EnterpriseEnrollmentHelper::SetupEnrollmentHelperMock(
&MultiLicenseEnrollmentScreenUnitTest::MockEnrollmentHelperCreator);
EXPECT_CALL(*GetMockScreenView(), SetEnrollmentConfig(_, _)).Times(1);
SetUpEnrollmentScreen();
EXPECT_CALL(*GetMockScreenView(), Show()).Times(1);
EXPECT_CALL(*GetMockScreenView(), ShowSigninScreen()).Times(1);
// Start enrollment.
enrollment_screen_->Show();
// Once at login, once after picking license type.
EXPECT_CALL(*GetMockScreenView(), ShowEnrollmentSpinnerScreen()).Times(2);
EXPECT_CALL(*GetMockScreenView(), ShowLicenseTypeSelectionScreen(_)).Times(1);
enrollment_screen_->OnLoginDone("user@domain.com", "oauth");
enrollment_screen_->OnLicenseTypeSelected("annual");
}
INSTANTIATE_TEST_CASE_P(
P,
AutomaticEnrollmentScreenUnitTest,
::testing::Values(
policy::EnrollmentConfig::MODE_ATTESTATION_INITIAL_SERVER_FORCED,
policy::EnrollmentConfig::MODE_ATTESTATION_SERVER_FORCED));
} // namespace chromeos