command.hpp

/*
 * Copyright 2020 Robert Bosch GmbH
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * SPDX-License-Identifier: Apache-2.0
 */
#pragma once
 
#include <optional>      // for optional<>
#include <string>        // for string
#include <system_error>  // for system_error
#include <utility>       // for move
#include <vector>        // for vector<>
 
#include <boost/process/child.hpp>   // for child
#include <cloe/core.hpp>             // for Logger, Json, Conf, ...
#include <cloe/trigger.hpp>          // for Action, ActionFactory, ...
#include <cloe/utility/command.hpp>  // for Command
 
namespace engine {
 
struct CommandResult {
  std::string name;
  std::string command;
  std::optional<boost::process::child> child;
  std::optional<int> exit_code;
  std::optional<std::system_error> error;
  std::vector<std::string> output;
};
 
class CommandExecuter {
 public:
  explicit CommandExecuter(cloe::Logger logger, bool enabled = true)
      : logger_(std::move(logger)), enabled_(enabled) {}
 
  [[nodiscard]] bool is_enabled() const { return enabled_; }
  void set_enabled(bool v) { enabled_ = v; }
 
  CommandResult run_and_release(const cloe::Command&) const; // NOLINT
 
  void run(const cloe::Command&);
 
  void run_all(const std::vector<cloe::Command>& cmds);
 
  void wait(CommandResult&) const;
 
  void wait_all();
 
  std::vector<CommandResult> release_all();
 
  [[nodiscard]] cloe::Logger logger() const { return logger_; }
 
 private:
  std::vector<CommandResult> handles_;
  cloe::Logger logger_{nullptr};
  bool enabled_{false};
};
 
namespace actions {
 
class Command : public cloe::Action {
 public:
  Command(const std::string& name, cloe::Command  cmd, CommandExecuter* exec)
      : Action(name), command_(std::move(cmd)), executer_(exec) {
    assert(executer_ != nullptr);
  }
 
  cloe::ActionPtr clone() const override {
    return std::make_unique<Command>(name(), command_, executer_);
  }
 
  cloe::CallbackResult operator()(const cloe::Sync& sync, cloe::TriggerRegistrar& registrar) override;
 
 protected:
  void to_json(cloe::Json& j) const override;
 
 private:
  cloe::Command command_;
  CommandExecuter* executer_{nullptr};
};
 
class CommandFactory : public cloe::ActionFactory {
 public:
  using ActionType = Command;
  explicit CommandFactory(CommandExecuter* exec)
      : cloe::ActionFactory("command", "run a system command"), executer_(exec) {
    assert(executer_ != nullptr);
  }
  [[nodiscard]] cloe::TriggerSchema schema() const override;
  [[nodiscard]] cloe::ActionPtr make(const cloe::Conf& c) const override;
  [[nodiscard]] cloe::ActionPtr make(const std::string& s) const override;
 
 private:
  CommandExecuter* executer_{nullptr};
};
 
}  // namespace actions
}  // namespace engine