src/system_data/configuration_data.h

// Copyright 2019 The Fuchsia 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 COBALT_SRC_SYSTEM_DATA_CONFIGURATION_DATA_H_
#define COBALT_SRC_SYSTEM_DATA_CONFIGURATION_DATA_H_

#include <iostream>
#include <string>

#include "src/lib/clearcut/clearcut_log_source.pb.h"

namespace cobalt::system_data {

// The environment that the Cobalt system should talk to.
enum Environment : uint8_t {
  // The default prod environment.
  PROD = 0,

  // The devel environment.
  DEVEL = 1,

  // Capture observations locally for testing purposes.
  LOCAL = 2
};

// Convert the Environment enum to a string (for logging).
const char* EnvironmentString(const Environment& environment);

// Streams EnvironmentString(environment) to `os`.
std::ostream& operator<<(std::ostream& os, Environment environment);

// Encapsulation of the configuration data used by Cobalt.
class ConfigurationData {
 public:
  explicit ConfigurationData(Environment environment) : environment_(environment) {}
  ~ConfigurationData() = default;

  // Get the environment that the Cobalt system should talk to.
  [[nodiscard]] Environment GetEnvironment() const { return environment_; }

  // Get a string of the environment that the Cobalt system should talk to (for logging).
  [[nodiscard]] const char* GetEnvironmentString() const { return EnvironmentString(environment_); }

  // Get the Clearcut Log Source ID that Cobalt should write its logs to.
  [[nodiscard]] cobalt::clearcut_protos::LogSourceEnum::LogSource GetLogSourceId() const;

 private:
  const Environment environment_;
};

// The current default configuration if no environment/config is specified.
static const ConfigurationData defaultConfigurationData(Environment::DEVEL);

}  // namespace cobalt::system_data

namespace cobalt::config {

using system_data::ConfigurationData;
using system_data::DEVEL;
using system_data::Environment;
using system_data::PROD;

}  // namespace cobalt::config

#endif  // COBALT_SRC_SYSTEM_DATA_CONFIGURATION_DATA_H_