FailureCause.h

#ifndef WRENCH_STANDARDJOBFAILURECAUSE_H
#define WRENCH_STANDARDJOBFAILURECAUSE_H


#include <set>
#include <string>

#include "wrench/services/Service.h"
#include "wrench/services/storage/StorageService.h"
#include "wrench/services/compute/ComputeService.h"

namespace wrench {

    class Service;
    class WorkflowFile;
    class WorkflowJob;
    class FileLocation;

    /***********************/
    /***********************/


    class FailureCause {

    public:

        FailureCause() = default;

        /***********************/
        /***********************/
        virtual ~FailureCause() = default;
        /***********************/
        /***********************/


        virtual std::string toString() = 0;

    };


    class NoScratchSpace : public FailureCause {

    public:
        /***********************/
        /***********************/
        NoScratchSpace(std::string error);
        /***********************/
        /***********************/

        std::string toString();
    private:
        std::string error;
    };

    class FileNotFound : public FailureCause {

    public:
        /***********************/
        /***********************/
        FileNotFound(WorkflowFile *file, std::shared_ptr<FileLocation>  location);
        /***********************/
        /***********************/

        WorkflowFile *getFile();
        std::shared_ptr<FileLocation>  getLocation();
        std::string toString();


    private:
        WorkflowFile *file;
        std::shared_ptr<FileLocation> location;
    };

    class StorageServiceNotEnoughSpace : public FailureCause {

    public:
        /***********************/
        /***********************/
        StorageServiceNotEnoughSpace(WorkflowFile *file, std::shared_ptr<StorageService>  storage_service);
        /***********************/
        /***********************/

        WorkflowFile *getFile();
        std::shared_ptr<StorageService>  getStorageService();
        std::string toString();


    private:
        WorkflowFile *file;
        std::shared_ptr<StorageService>  storage_service;
    };

//    /**
//     * @brief A "file is already there" failure cause
//     */
//    class StorageServiceFileAlreadyThere : public FailureCause {
//
//    public:
//        /***********************/
//        /** \cond INTERNAL     */
//        /***********************/
//        StorageServiceFileAlreadyThere(WorkflowFile *file, std::shared_ptr<StorageService>  storage_service);
//        /***********************/
//        /** \endcond           */
//        /***********************/
//
//        WorkflowFile *getFile();
//        std::shared_ptr<StorageService>  getStorageService();
//        std::string toString();
//
//
//    private:
//        WorkflowFile *file;
//        std::shared_ptr<StorageService>  storage_service;
//    };

    class InvalidDirectoryPath : public FailureCause {

    public:
        /***********************/
        /***********************/
        InvalidDirectoryPath(
                std::shared_ptr<StorageService> storage_service,
                std::string invalid_path);
        /***********************/
        /***********************/

        std::shared_ptr<StorageService>  getStorageService();
        std::string  getInvalidPath();
        std::string toString();


    private:
        std::shared_ptr<StorageService>  storage_service;
        std::string  invalid_path;
    };


    class FileLocation;

    class FileAlreadyBeingCopied : public FailureCause {


    public:
        /***********************/
        /***********************/
        FileAlreadyBeingCopied(WorkflowFile *file,
                               std::shared_ptr<FileLocation> src,
                               std::shared_ptr<FileLocation> dst);
        /***********************/
        /***********************/

        WorkflowFile *getFile();
        std::shared_ptr<FileLocation> getSourceLocation();
        std::shared_ptr<FileLocation> getDestinationLocation();
        std::string toString();

    private:
        WorkflowFile *file;
        std::shared_ptr<FileLocation> src_location;
        std::shared_ptr<FileLocation> dst_location;
    };

    class ServiceIsDown : public FailureCause {
    public:
        /***********************/
        /***********************/
        explicit ServiceIsDown(std::shared_ptr<Service> service);
        /***********************/
        /***********************/

        std::shared_ptr<Service> getService();
        std::string toString() override;

    private:
        std::shared_ptr<Service> service;
    };

    class ServiceIsSuspended : public FailureCause {
    public:
        /***********************/
        /***********************/
        explicit ServiceIsSuspended(std::shared_ptr<Service> service);
        /***********************/
        /***********************/

        std::shared_ptr<Service> getService();
        std::string toString() override;

    private:
        std::shared_ptr<Service> service;
    };

    class JobTypeNotSupported : public FailureCause {
    public:
        /***********************/
        /***********************/
        JobTypeNotSupported(WorkflowJob *job, std::shared_ptr<ComputeService>  compute_service);
        /***********************/
        /***********************/

        WorkflowJob *getJob();
        std::shared_ptr<ComputeService>  getComputeService();
        std::string toString();

    private:
        WorkflowJob *job;
        std::shared_ptr<ComputeService>  compute_service;
    };

    class FunctionalityNotAvailable : public FailureCause {
    public:
        /***********************/
        /***********************/
        FunctionalityNotAvailable(std::shared_ptr<Service>  service, std::string functionality_name);
        /***********************/
        /***********************/

        std::shared_ptr<Service>  getService();
        std::string getFunctionalityName();
        std::string toString();

    private:
        std::shared_ptr<Service>  service;
        std::string functionality_name;
    };


    class NotEnoughResources : public FailureCause {
    public:
        /***********************/
        /***********************/
        NotEnoughResources(WorkflowJob *job, std::shared_ptr<ComputeService> compute_service);
        /***********************/
        /***********************/

        WorkflowJob *getJob();
        std::shared_ptr<ComputeService> getComputeService();
        std::string toString();

    private:
        WorkflowJob *job;
        std::shared_ptr<ComputeService> compute_service;
    };

    class JobKilled : public FailureCause {
    public:
        /***********************/
        /***********************/
        JobKilled(WorkflowJob *job, std::shared_ptr<ComputeService> compute_service);
        /***********************/
        /***********************/

        WorkflowJob *getJob();
        std::shared_ptr<ComputeService> getComputeService();
        std::string toString();

    private:
        WorkflowJob *job;
        std::shared_ptr<ComputeService> compute_service;
    };


    class NetworkError : public FailureCause {
    public:
        enum OperationType {
            SENDING,
            RECEIVING
        };

        enum ErrorType {
            TIMEOUT,
            FAILURE
        };

        /***********************/
        /***********************/
        NetworkError(NetworkError::OperationType, NetworkError::ErrorType, std::string mailbox);
        /***********************/
        /***********************/

        std::string toString();
        bool whileReceiving();
        bool whileSending();
        bool isTimeout();
        std::string getMailbox();

    private:
        NetworkError::OperationType operation_type;
        NetworkError::ErrorType error_type;
        bool while_sending = false;
        std::string mailbox = "";
    };

    class HostError : public FailureCause {
    public:

        /***********************/
        /***********************/
        HostError(std::string hostname);

        /***********************/
        /***********************/

        std::string toString();

    private:
        std::string hostname;
    };


    class ComputeThreadHasDied : public FailureCause {
    public:
        /***********************/
        /***********************/
        ComputeThreadHasDied();
        /***********************/
        /***********************/

        std::string toString();

    private:
    };

    class FatalFailure : public FailureCause {
    public:
        /***********************/
        /***********************/
        FatalFailure();
        /***********************/
        /***********************/

        std::string toString();

    private:
    };


    class JobTimeout : public FailureCause {
    public:
        /***********************/
        /***********************/
        JobTimeout(WorkflowJob *job);
        /***********************/
        /***********************/

        WorkflowJob *getJob();
        std::string toString();

    private:
        WorkflowJob *job;
    };

    class NotAllowed : public FailureCause {
    public:
        /***********************/
        /***********************/
        NotAllowed(std::shared_ptr<Service> service, std::string &error_message);
        /***********************/
        /***********************/

        std::shared_ptr<Service> getService();
        std::string toString();

    private:
        std::shared_ptr<Service> service;
        std::string error_message;
    };



    /***********************/
    /***********************/
};


#endif //WRENCH_STANDARDJOBFAILURECAUSE_H