kernel/tests/debug.cpp

/* This file is part of the KDE project
   Copyright (C) 2009, 2010 Dag Andersen <danders@get2net.dk>
   Copyright (C) 2016 Dag Andersen <danders@get2net.dk>

   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Library General Public
   License as published by the Free Software Foundation; either
   version 2 of the License, or (at your option) any later version.

   This library is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
   Library General Public License for more details.

   You should have received a copy of the GNU Library General Public License
   along with this library; see the file COPYING.LIB.  If not, write to
   the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
   Boston, MA 02110-1301, USA.
*/

// clazy:excludeall=qstring-arg
#include "kptappointment.h"
#include "kptcalendar.h"
#include "kptdatetime.h"
#include "kptproject.h"
#include "kptresource.h"
#include "kptnode.h"
#include "kpttask.h"
#include "kptschedule.h"

#include <QTest>
#include <QStringList>
#include <QString>


namespace QTest
{
    template<>
    char *toString(const KPlato::DateTime &dt)
    {
        QString s;
        switch (dt.timeSpec()) {
            case Qt::LocalTime: s = " LocalTime"; break;
            case Qt::UTC: s = " UTC"; break;
            case Qt::OffsetFromUTC: s = " OffsetFromUTC"; break;
            case Qt::TimeZone: s = " TimeZone (" + dt.timeZone().id() + ')'; break;
        }
        return toString(QString("%1T%2 %3").arg(dt.date().toString(Qt::ISODate), dt.time().toString("hh:mm:ss.zzz"), s));
    }

    template<>
    char *toString(const KPlato::Duration &d)
    {
        return toString(d.toString());
    }
}

namespace KPlato
{

class Debug
{
public:
    Debug() {}
static
void print(Calendar *c, const QString &str, bool full = true) {
    Q_UNUSED(full);
    QTimeZone tz = c->timeZone();
    QString s = tz.isValid() ? QString::fromLatin1(tz.id()) : QStringLiteral("LocalTime");

    qDebug()<<"Debug info: Calendar"<<c->name()<<s<<str;
    for (int wd = 1; wd <= 7; ++wd) {
        CalendarDay *d = c->weekday(wd);
        qDebug()<<"   "<<wd<<':'<<d->stateToString(d->state());
        foreach (TimeInterval *t,  d->timeIntervals()) {
            qDebug()<<"      interval:"<<t->first<<t->second<<'('<<Duration(qint64(t->second)).toString()<<')';
        }
    }
    foreach (const CalendarDay *d, c->days()) {
        qDebug()<<"   "<<d->date()<<':';
        foreach (TimeInterval *t,  d->timeIntervals()) {
            qDebug()<<"      interval:"<<t->first<<t->second;
        }
    }
}
static
QString printAvailable(Resource *r, const QString &lead = QString()) {
    QStringList sl;
    sl<<lead<<"Available:"
        <<(r->availableFrom().isValid()
                ? r->availableFrom().toString()
                : (r->project() ? ('('+r->project()->constraintStartTime().toString()+')') : QString()))
        <<(r->availableUntil().isValid()
                ? r->availableUntil().toString()
                : (r->project() ? ('('+r->project()->constraintEndTime().toString()+')') : QString()))
        <<QString::number(r->units())<<"%"
        <<"cost: normal"<<QString::number(r->normalRate())<<" overtime"<<QString::number(r->overtimeRate());
    return sl.join(" ");
}
static
void print(Resource *r, const QString &str, bool full = true) {
    qDebug()<<"Debug info: Resource"<<r->name()<<str;
    qDebug()<<"Parent group:"<<(r->parentGroup()
                ? (r->parentGroup()->name() + " Type: "+ r->parentGroup()->typeToString())
                : QString("None"));
    qDebug()<<"Available:"
        <<(r->availableFrom().isValid()
                ? r->availableFrom().toString()
                : (r->project() ? ('('+r->project()->constraintStartTime().toString()+')') : QString()))
        <<(r->availableUntil().isValid()
                ? r->availableUntil().toString()
                : (r->project() ? ('('+r->project()->constraintEndTime().toString()+')') : QString()))
        <<r->units()<<'%';
    qDebug()<<"Type:"<<r->typeToString();
    if (r->type() == Resource::Type_Team) {
        qDebug()<<"Team members:"<<r->teamMembers().count();
        foreach (Resource *tm, r->teamMembers()) {
            qDebug()<<"   "<<tm->name()<<"Available:"
                    <<(r->availableFrom().isValid()
                            ? r->availableFrom().toString()
                            : (r->project() ? ('('+r->project()->constraintStartTime().toString()+')') : QString()))
                    <<(r->availableUntil().isValid()
                            ? r->availableUntil().toString()
                            : (r->project() ? ('('+r->project()->constraintEndTime().toString()+')') : QString()))
                    <<r->units()<<'%';
        }
    } else {
        Calendar *cal = r->calendar(true);
        QString s;
        if (cal) {
            s = cal->name();
        } else {
            cal = r->calendar(false);
            if (cal) {
                s = cal->name() + " (Default)";
            } else {
                s = "No calendar";
            }
        }
        qDebug()<<"Calendar:"<<s;
        if (cal) {
            print(cal, "Resource calendar");
        }
    }
    if (! full) return;
    qDebug()<<"External appointments:"<<r->numExternalAppointments();
    foreach (Appointment *a, r->externalAppointmentList()) {
        qDebug()<<"   appointment:"<<a->startTime().toString()<<a->endTime().toString();
        foreach(const AppointmentInterval &i, a->intervals().map()) {
            qDebug()<<"      "<<i.startTime().toString()<<i.endTime().toString()<<i.load();
        }
    }
}
static
void print(Project *p, const QString &str, bool all = false) {
    qDebug()<<"Debug info: Project"<<p->name()<<str;
    qDebug()<<"project target start:"<<QTest::toString(QDateTime(p->constraintStartTime()));
    qDebug()<<"  project target end:"<<QTest::toString(QDateTime(p->constraintEndTime()));
    if (p->isScheduled()) {
        qDebug()<<"  project start time:"<<QTest::toString(QDateTime(p->startTime()));
        qDebug()<<"    project end time:"<<QTest::toString(QDateTime(p->endTime()));
    } else {
        qDebug()<<" Not scheduled";
    }

    if (! all) {
        return;
    }
    for (int i = 0; i < p->numChildren(); ++i) {
        qDebug();
        print(static_cast<Task*>(p->childNode(i)), true);
    }
}
static
void print(Project *p, Task *t, const QString &str, bool full = true) {
    Q_UNUSED(full);
    print(p, str);
    print(t);
}
static
void print(Task *t, const QString &str, bool full = true) {
    qDebug()<<"Debug info: Task"<<t->name()<<str;
    print(t, full);
}
static
void print(Task *t, bool full = true) {
    QString pad;
    if (t->level() > 0) {
        pad = QString("%1").arg("", t->level()*2, ' ');
    }
    qDebug()<<pad<<"Task"<<t->name()<<t->typeToString()<<t->constraintToString();
    if (t->isScheduled()) {
        qDebug()<<pad<<"     earlyStart:"<<QTest::toString(QDateTime(t->earlyStart()));
        qDebug()<<pad<<"      lateStart:"<<QTest::toString(QDateTime(t->lateStart()));
        qDebug()<<pad<<"    earlyFinish:"<<QTest::toString(QDateTime(t->earlyFinish()));
        qDebug()<<pad<<"     lateFinish:"<<QTest::toString(QDateTime(t->lateFinish()));
        qDebug()<<pad<<"      startTime:"<<QTest::toString(QDateTime(t->startTime()));
        qDebug()<<pad<<"        endTime:"<<QTest::toString(QDateTime(t->endTime()));
    } else {
        qDebug()<<pad<<"   Not scheduled";
    }
    qDebug()<<pad;
    switch (t->constraint()) {
        case Node::MustStartOn:
        case Node::StartNotEarlier:
            qDebug()<<pad<<"startConstraint:"<<QTest::toString(QDateTime(t->constraintStartTime()));
            break;
        case Node::FixedInterval:
            qDebug()<<pad<<"startConstraint:"<<QTest::toString(QDateTime(t->constraintStartTime()));
        case Node::MustFinishOn:
        case Node::FinishNotLater:
            qDebug()<<pad<<"  endConstraint:"<<QTest::toString(QDateTime(t->constraintEndTime()));
            break;
        default: break;
    }
    qDebug()<<pad<<"Estimate   :"<<t->estimate()->expectedEstimate()<<Duration::unitToString(t->estimate()->unit())
            <<t->estimate()->typeToString()
            <<(t->estimate()->type() == Estimate::Type_Duration
                ? (t->estimate()->calendar()?t->estimate()->calendar()->name():"Fixed")
                : QString("%1 h").arg(t->estimate()->expectedValue().toDouble(Duration::Unit_h)));

    foreach (ResourceGroupRequest *gr, t->requests().requests()) {
        qDebug()<<pad<<"Group request:"<<gr->group()->name()<<gr->units();
        foreach (ResourceRequest *rr, gr->resourceRequests()) {
            qDebug()<<pad<<printAvailable(rr->resource(), "   " + rr->resource()->name());
        }
    }
    if (t->isStartNode()) {
        qDebug()<<pad<<"Start node";
    }
    QStringList rel;
    foreach (Relation *r, t->dependChildNodes()) {
        QString type;
        switch(r->type()) {
        case Relation::StartStart: type = "SS"; break;
        case Relation::FinishFinish: type = "FF"; break;
        default: type = "FS"; break;
        }
        rel << QString("(%1) -> %2, %3 %4").arg(r->parent()->name()).arg(r->child()->name()).arg(type).arg(r->lag() == 0?QString():r->lag().toString(Duration::Format_HourFraction));
    }
    if (!rel.isEmpty()) {
        qDebug()<<pad<<"Successors:"<<rel.join(" : ");
    }
    if (t->isEndNode()) {
        qDebug()<<pad<<"End node";
    }
    rel.clear();
    foreach (Relation *r, t->dependParentNodes()) {
        QString type;
        switch(r->type()) {
        case Relation::StartStart: type = "SS"; break;
        case Relation::FinishFinish: type = "FF"; break;
        default: type = "FS"; break;
        }
        rel << QString("%1 -> (%2), %3 %4").arg(r->parent()->name()).arg(r->child()->name()).arg(type).arg(r->lag() == 0?QString():r->lag().toString(Duration::Format_HourFraction));
    }
    if (!rel.isEmpty()) {
        qDebug()<<pad<<"Predeccessors:"<<rel.join(" : ");
    }
    qDebug()<<pad;
    Schedule *s = t->currentSchedule();
    if (s) {
        qDebug()<<pad<<"Appointments:"<<s->appointments().count();
        foreach (Appointment *a, s->appointments()) {
            qDebug()<<pad<<"  Resource:"<<a->resource()->resource()->name()<<"booked:"<<QTest::toString(QDateTime(a->startTime()))<<QTest::toString(QDateTime(a->endTime()))<<"effort:"<<a->effort(a->startTime(), a->endTime()).toDouble(Duration::Unit_h)<<'h';
            if (! full) { continue; }
            foreach(const AppointmentInterval &i, a->intervals().map()) {
                qDebug()<<pad<<"    "<<QTest::toString(QDateTime(i.startTime()))<<QTest::toString(QDateTime(i.endTime()))<<i.load()<<"effort:"<<i.effort(i.startTime(), i.endTime()).toDouble(Duration::Unit_h)<<'h';
            }
        }
    }
    if (t->runningAccount()) {
        qDebug()<<pad<<"Running account :"<<t->runningAccount()->name();
    }
    if (t->startupAccount()) {
        qDebug()<<pad<<"Startup account :"<<t->startupAccount()->name()<<" cost:"<<t->startupCost();
    }
    if (t->shutdownAccount()) {
        qDebug()<<pad<<"Shutdown account:"<<t->shutdownAccount()->name()<<" cost:"<<t->shutdownCost();
    }
    if (full) {
        for (int i = 0; i < t->numChildren(); ++i) {
            qDebug()<<pad;
            print(static_cast<Task*>(t->childNode(i)), full);
        }
    }
}
static
void print(const Completion &c, const QString &name, const QString &s = QString()) {
    qDebug()<<"Completion:"<<name<<s;
    qDebug()<<"  Entry mode:"<<c.entryModeToString();
    qDebug()<<"     Started:"<<c.isStarted()<<c.startTime();
    qDebug()<<"    Finished:"<<c.isFinished()<<c.finishTime();
    qDebug()<<"  Completion:"<<c.percentFinished()<<'%';

    if (! c.usedEffortMap().isEmpty()) {
        qDebug()<<"     Used effort:";
        foreach (const Resource *r, c.usedEffortMap().keys()) {  // clazy:exclude=container-anti-pattern
            Completion::UsedEffort *ue = c.usedEffort(r);
            foreach (const QDate &d, ue->actualEffortMap().keys()) { // clazy:exclude=container-anti-pattern
                qDebug()<<"         "<<r->name()<<':';
                qDebug()<<"             "<<d.toString(Qt::ISODate)<<':'<<c.actualEffort(d).toString()<<c.actualCost(d);
            }
        }
    }
}
static
void print(const EffortCostMap &m, const QString &s = QString()) {
    qDebug()<<"EffortCostMap"<<s;
    if (m.days().isEmpty()) {
        qDebug()<<"   Empty";
        return;
    }
    qDebug()<<m.startDate().toString(Qt::ISODate)<<m.endDate().toString(Qt::ISODate)
            <<" total="
            <<m.totalEffort().toString()
            <<m.totalCost()
            <<'('
            <<m.bcwpTotalEffort()
            <<m.bcwpTotalCost()
            <<')';

    if (! m.days().isEmpty()) {
        foreach (const QDate &d, m.days().keys()) { // clazy:exclude=container-anti-pattern
            qDebug()<<"   "<<d.toString(Qt::ISODate)<<':'<<m.hoursOnDate(d)<<'h'<<m.costOnDate(d)
                                                    <<'('<<m.bcwpEffortOnDate(d)<<'h'<<m.bcwpCostOnDate(d)<<')';
        }
    }
}
static
void printSchedulingLog(const ScheduleManager &sm, const QString &s)
{
    qDebug()<<"Scheduling log"<<s;
    qDebug()<<"Scheduling:"<<sm.name()<<(sm.recalculate()?QString("recalculate from %1").arg(sm.recalculateFrom().toString()):"");
    foreach (const QString &s, sm.expected()->logMessages()) {
        qDebug()<<s;
    }
}
static
void print(Account *a, long id = -1, const QString &s = QString())
{
    qDebug()<<"Debug info Account:"<<a->name()<<s;
    qDebug()<<"Account:"<<a->name()<<(a->isDefaultAccount() ? "Default" : "");
    EffortCostMap ec = a->plannedCost(id);
    qDebug()<<"Planned cost:"<<ec.totalCost()<<"effort:"<<ec.totalEffort().toString();
    if (! a->isElement()) {
        foreach (Account *c, a->accountList()) {
            print(c);
        }
        return;
    }
    qDebug()<<"Cost places:";
    foreach (Account::CostPlace *cp, a->costPlaces()) {
        qDebug()<<"     Node:"<<(cp->node() ? cp->node()->name() : "");
        qDebug()<<"  running:"<<cp->running();
        qDebug()<<"  startup:"<<cp->startup();
        qDebug()<<" shutdown:"<<cp->shutdown();
    }
}

static
void print(const AppointmentInterval &i, const QString &indent = QString())
{
    QString s = indent + "Interval:";
    if (! i.isValid()) {
        qDebug()<<s<<"Not valid";
    } else {
        qDebug()<<s<<i.startTime()<<i.endTime()<<i.load()<<'%';
    }
}

static
void print(const AppointmentIntervalList &lst, const QString &s = QString())
{
    qDebug()<<"Interval list:"<<lst.map().count()<<s;
    foreach (const AppointmentInterval &i, lst.map()) {
        print(i, "  ");
    }
}

};

}