FailureCause.h

#ifndef WRENCH_STANDARDJOBFAILURECAUSE_H
#define WRENCH_STANDARDJOBFAILURECAUSE_H


#include <set>
#include <string>

namespace wrench {

    class Service;
    class WorkflowFile;
    class StorageService;
    class ComputeService;
    class WorkflowJob;

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


    class FailureCause {

    public:

        enum CauseType {
                    FATAL_FAILURE,
                    NO_STORAGE_SERVICE_FOR_FILE,
                    NO_SCRATCH_SPACE,
                    FILE_NOT_FOUND,
                    FILE_ALREADY_THERE,
                    FILE_ALREADY_BEING_COPIED,
                    STORAGE_NOT_ENOUGH_SPACE,
                    SERVICE_DOWN,
                    JOB_TYPE_NOT_SUPPORTED,
                    NOT_ENOUGH_RESOURCES,
                    NETWORK_ERROR,
                    NETWORK_TIMEOUT,
                    JOB_KILLED,
                    JOB_CANNOT_BE_TERMINATED,
                    JOB_CANNOT_BE_FORGOTTEN,
                    COMPUTE_THREAD_HAS_DIED,
                    FUNCTIONALITY_NOT_AVAILABLE,
                    JOB_TIMEOUT,
                    HOST_ERROR

        };

        explicit FailureCause(CauseType cause);

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


        virtual std::string toString() = 0;

        CauseType getCauseType();

    private:
        CauseType cause;
    };


    class NoStorageServiceForFile : public FailureCause {

    public:
        /***********************/
        /***********************/
        NoStorageServiceForFile(WorkflowFile *file);
        /***********************/
        /***********************/

        WorkflowFile *getFile();
        std::string toString();

    private:
        WorkflowFile *file;
    };


    class NoScratchSpace : public FailureCause {

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

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

    class FileNotFound : public FailureCause {

    public:
        /***********************/
        /***********************/
        FileNotFound(WorkflowFile *file, StorageService *storage_service);
        /***********************/
        /***********************/

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


    private:
        WorkflowFile *file;
        StorageService *storage_service;
    };

    class StorageServiceNotEnoughSpace : public FailureCause {

    public:
        /***********************/
        /***********************/
        StorageServiceNotEnoughSpace(WorkflowFile *file, StorageService *storage_service);
        /***********************/
        /***********************/

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


    private:
        WorkflowFile *file;
        StorageService *storage_service;
    };

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

    class FileAlreadyBeingCopied : public FailureCause {

    public:
        /***********************/
        /***********************/
        FileAlreadyBeingCopied(WorkflowFile *file, StorageService *dst, std::string dst_partition);
        /***********************/
        /***********************/

        WorkflowFile *getFile();
        StorageService *getStorageService();
        std::string getPartition();
        std::string toString();

    private:
        WorkflowFile *file;
        StorageService *storage_service;
        std::string dst_partition;
    };

    class
    ServiceIsDown : public FailureCause {
    public:
        /***********************/
        /***********************/
        explicit ServiceIsDown(Service *service);
        /***********************/
        /***********************/

        Service *getService();
        std::string toString() override;

    private:
        Service *service;
    };

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

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

    private:
        WorkflowJob *job;
        ComputeService *compute_service;
    };

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

        Service *getService();
        std::string getFunctionalityName();
        std::string toString();

    private:
        Service *service;
        std::string functionality_name;
    };


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

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

    private:
        WorkflowJob *job;
        ComputeService *compute_service;
    };

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

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

    private:
        WorkflowJob *job;
        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 JobCannotBeTerminated : public FailureCause {
    public:
        /***********************/
        /***********************/
        JobCannotBeTerminated(WorkflowJob *job);
        /***********************/
        /***********************/

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

    private:
        WorkflowJob *job;
    };

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

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

    private:
        WorkflowJob *job;
    };

    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;
    };


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


#endif //WRENCH_STANDARDJOBFAILURECAUSE_H