chromium/chrome/browser/ash/extensions/speech/speech_recognition_private_base_test.h

// Copyright 2021 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef CHROME_BROWSER_ASH_EXTENSIONS_SPEECH_SPEECH_RECOGNITION_PRIVATE_BASE_TEST_H_
#define CHROME_BROWSER_ASH_EXTENSIONS_SPEECH_SPEECH_RECOGNITION_PRIVATE_BASE_TEST_H_

#include <memory>

#include "base/test/scoped_feature_list.h"
#include "chrome/browser/extensions/extension_apitest.h"
#include "chrome/browser/speech/speech_recognition_constants.h"
#include "chrome/browser/speech/speech_recognition_test_helper.h"
#include "content/public/test/browser_test.h"

namespace extensions {

// This class automatically sets up and tears down the speech recognition
// service depending on a test's parameter value. It is used by various tests
// within the speech recognition private code base. Among these are the
// SpeechRecognitionPrivateApiTest (which needs the ExtensionApiTest
// infrastructure), as well as SpeechRecognitionPrivateManagerTest and
// SpeechRecognitionPrivateRecognizerTest. To support all of these tests with a
// single base class, this class inherits from ExtensionApiTest. Inheriting from
// any other test type, e.g. InProcessBrowserTest or BrowserTestBase, results in
// an inheritance diamond problem, since the SpeechRecognitionPrivateApiTest
// needs infrastructure from both this class and the ExtensionApiTest to run.
class SpeechRecognitionPrivateBaseTest
    : public ExtensionApiTest,
      public ::testing::WithParamInterface<speech::SpeechRecognitionType> {
 protected:
  SpeechRecognitionPrivateBaseTest();
  ~SpeechRecognitionPrivateBaseTest() override;
  SpeechRecognitionPrivateBaseTest(const SpeechRecognitionPrivateBaseTest&) =
      delete;
  SpeechRecognitionPrivateBaseTest& operator=(
      const SpeechRecognitionPrivateBaseTest&) = delete;

  // ExtensionApiTest:
  void SetUpCommandLine(base::CommandLine* command_line) override;
  void SetUpOnMainThread() override;
  void TearDownOnMainThread() override;

  // Runs a speech recognition private test.
  bool RunSpeechRecognitionPrivateTest(const std::string& dir_name);
  // Loads a test extension from the speech recognition private directory as a
  // component extension, which is required to use the speech recognition
  // private API.
  const Extension* LoadExtensionAsComponent(const std::string& dir_name);

  // Routers to SpeechRecognitionTestHelper methods.
  void WaitForRecognitionStarted();
  void WaitForRecognitionStopped();
  void SendInterimResultAndWait(const std::string& transcript);
  void SendFinalResultAndWait(const std::string& transcript);
  void SendErrorAndWait();

 private:
  SpeechRecognitionTestHelper test_helper_;
  base::test::ScopedFeatureList scoped_feature_list_;
};

}  // namespace extensions

#endif  // CHROME_BROWSER_ASH_EXTENSIONS_SPEECH_SPEECH_RECOGNITION_PRIVATE_BASE_TEST_H_