chrome/browser/extensions/test_extension_dir.h

   1 // Copyright 2013 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef CHROME_BROWSER_EXTENSIONS_TEST_EXTENSION_DIR_H_
   6 #define CHROME_BROWSER_EXTENSIONS_TEST_EXTENSION_DIR_H_
   7
   8 #include "base/files/file_path.h"
   9 #include "base/files/scoped_temp_dir.h"
  10 #include "base/strings/string_piece.h"
  11
  12 namespace extensions {
  13
  14 // Provides a temporary directory to build an extension into.  This lets all of
  15 // an extension's code live inside the test instead of in a separate directory.
  16 class TestExtensionDir {
  17  public:
  18   TestExtensionDir();
  19
  20   ~TestExtensionDir();
  21
  22   // Writes |manifest| to manifest.json within the unpacked dir.  No validation
  23   // is performed. If desired this should be done on extension installation.
  24   void WriteManifest(base::StringPiece manifest);
  25
  26   // Like WriteManifest, but where the |manifest| is given in single-quotes
  27   // rather than double-quotes. This is for convenience to avoid escaping.
  28   //
  29   // E.g. |manifest| can be {'name': 'me'} rather than {\"name\": \"me\"}.
  30   void WriteManifestWithSingleQuotes(base::StringPiece manifest);
  31
  32   // Writes |contents| to |filename| within the unpacked dir, overwriting
  33   // anything that was already there.
  34   void WriteFile(const base::FilePath::StringType& filename,
  35                  base::StringPiece contents);
  36
  37   // Packs the extension into a .crx, and returns the path to that
  38   // .crx. Multiple calls to Pack() will produce extensions with the same ID.
  39   base::FilePath Pack();
  40
  41   // Returns the path to the unpacked directory.
  42   base::FilePath unpacked_path() {
  43     return dir_.path();
  44   }
  45
  46  private:
  47   // Stores files that make up the extension.
  48   base::ScopedTempDir dir_;
  49
  50   // Stores the generated .crx and .pem.
  51   base::ScopedTempDir crx_dir_;
  52 };
  53
  54 }  // namespace extensions
  55
  56 #endif  // CHROME_BROWSER_EXTENSIONS_TEST_EXTENSION_DIR_H_