chrome/test/base/layout_test_http_server.h

// Copyright (c) 2011 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.

#ifndef CHROME_TEST_BASE_LAYOUT_TEST_HTTP_SERVER_H_
#define CHROME_TEST_BASE_LAYOUT_TEST_HTTP_SERVER_H_
#pragma once

#include "base/compiler_specific.h"
#include "base/file_path.h"

#if defined(OS_WIN)
#include "base/win/scoped_handle.h"
#endif

// This object bounds the lifetime of an external HTTP server
// used for layout tests.
//
// NOTE: If you're not running a layout test, you probably want
// a more lightweight net/test/test_server HTTP server.
class LayoutTestHttpServer {
 public:
  LayoutTestHttpServer(const FilePath& root_directory, int port);
  ~LayoutTestHttpServer();

  // Starts the server. Returns true on success.
  bool Start() WARN_UNUSED_RESULT;

  // Stops the server. Returns true on success.
  //
  // NOTE: It is recommended to explicitly call Stop and check its return value.
  // If Stop fails, the server is most likely still running and future attempts
  // to bind to the same port will fail, possibly resulting in further test
  // failures.
  bool Stop() WARN_UNUSED_RESULT;

 private:
  FilePath root_directory_;  // Root directory of the server.

  int port_;  // Port on which the server should listen.

  bool running_;  // True if the server is currently running.

#if defined(OS_WIN)
  // JobObject used to clean up orphaned child processes.
  base::win::ScopedHandle job_handle_;
#endif

  DISALLOW_COPY_AND_ASSIGN(LayoutTestHttpServer);
};

#endif  // CHROME_TEST_BASE_LAYOUT_TEST_HTTP_SERVER_H_