aboutsummaryrefslogtreecommitdiffstats
path: root/controller-api/src/main/java/com/yahoo/vespa/hosted/controller/api/integration/organization/Issue.java
blob: 11f497ce2ca16369b668a07845ac23ed219e690c (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
// Copyright Vespa.ai. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.vespa.hosted.controller.api.integration.organization;

import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.Optional;

/**
 * Represents an issue which needs to reported, typically from the controller, to a responsible party,
 * the identity of which is determined by the propertyId and, possibly, assignee fields.
 *
 * @author jonmv
 */
public class Issue {

    private final String summary;
    private final String description;
    private final List<String> labels;
    private final User assignee;
    private final AccountId assigneeId;
    private final Type type;
    private final String queue;
    private final Optional<String> component;

    private Issue(String summary, String description, List<String> labels, User assignee,
                  AccountId assigneeId, Type type, String queue, Optional<String> component) {
        if (summary.isEmpty()) throw new IllegalArgumentException("Issue summary can not be empty!");
        if (description.isEmpty()) throw new IllegalArgumentException("Issue description can not be empty!");

        this.summary = summary;
        this.description = description;
        this.labels = List.copyOf(labels);
        this.assignee = assignee;
        this.assigneeId = assigneeId;
        this.type = type;
        this.queue = queue;
        this.component = component;
    }

    public Issue(String summary, String description, String queue, Optional<String> component) {
        this(summary, description, Collections.emptyList(), null,  null, Type.defect, queue, component);
    }

    public Issue append(String appendage) {
        return new Issue(summary, description + appendage, labels, assignee, assigneeId, type, queue, component);
    }

    public Issue with(String label) {
        List<String> labels = new ArrayList<>(this.labels);
        labels.add(label);
        return new Issue(summary, description, labels, assignee, assigneeId, type, queue, component);
    }

    public Issue with(List<String> labels) {
        List<String> newLabels = new ArrayList<>(this.labels);
        newLabels.addAll(labels);
        return new Issue(summary, description, newLabels, assignee, assigneeId, type, queue, component);
    }

    public Issue with(AccountId assigneeId) {
        return new Issue(summary, description, labels, null, assigneeId, type, queue, component);
    }

    public Issue with(User assignee) {
        return new Issue(summary, description, labels, assignee, null, type, queue, component);
    }

    public Issue with(Type type) {
        return new Issue(summary, description, labels, assignee, assigneeId, type, queue, component);
    }

    public Issue in(String queue) {
        return new Issue(summary, description, labels, assignee, assigneeId, type, queue, Optional.empty());
    }

    public Issue withoutComponent() {
        return new Issue(summary, description, labels, assignee, assigneeId, type, queue, Optional.empty());
    }

    public String summary() {
        return summary;
    }

    public String description() {
        return description;
    }

    public List<String> labels() {
        return labels;
    }

    public Optional<User> assignee() { return Optional.ofNullable(assignee);
    }

    public Optional<AccountId> assigneeId() {
        return Optional.ofNullable(assigneeId);
    }

    public Type type() {
        return type;
    }

    public String queue() {
        return queue;
    }

    public Optional<String> component() {
        return component;
    }

    public enum Type {

        defect, // A defect which needs fixing.
        task,   // A task the humans must perform.
        operationalTask // SRE and operational tasks.

    }

}