aboutsummaryrefslogtreecommitdiffstats
path: root/cmso-optimizer/src/main/java/org/onap/optf/cmso/optimizer/clients/optimizer/ElementAvailability.java
blob: ac5d2e7966c83ce9e370548cc9b1d7ea28ba9ec2 (plain)
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
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
/*
 *  ============LICENSE_START==============================================
 *  Copyright (c) 2019 AT&T Intellectual Property.
 *  =======================================================================
 *  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.
 * ============LICENSE_END=================================================
 */

package org.onap.optf.cmso.optimizer.clients.optimizer;

import com.google.ical.compat.jodatime.DateTimeIterator;
import java.text.ParseException;
import java.util.ArrayList;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.TreeMap;
import org.joda.time.DateTime;
import org.onap.optf.cmso.optimizer.availability.policies.model.TimeLimitAndVerticalTopology;
import org.onap.optf.cmso.optimizer.availability.timewindows.RecurringWindows;
import org.onap.optf.cmso.optimizer.clients.optimizer.models.OptimizerParameters;
import org.onap.optf.cmso.optimizer.clients.ticketmgt.models.ActiveTicketsResponse;
import org.onap.optf.cmso.optimizer.clients.ticketmgt.models.TicketData;
import org.onap.optf.cmso.optimizer.clients.topology.models.TopologyElementInfo;
import org.onap.optf.cmso.optimizer.clients.topology.models.TopologyResponse;
import org.onap.optf.cmso.optimizer.service.rs.models.ChangeWindow;
import org.onap.optf.cmso.optimizer.service.rs.models.OptimizerRequest;

/**
 * The Class ElementAvailability.
 */
public class ElementAvailability extends ElementWindowMapping {

    private List<TimeLimitAndVerticalTopology> policies;
    private ActiveTicketsResponse ticketResponse;

    private OptimizerParameters parameters = null;

    private List<List<ChangeWindow>> globalRelativeAvailability = new ArrayList<>();

    private Map<String, List<TicketData>> nodeUnAvailability = new TreeMap<>();

    /**
     * Instantiates a new element availability.
     *
     * @param policies the policies
     * @param optimizerRequest the optimizer request
     * @param topologyResponse the topology response
     * @param ticketResponse the ticket response
     * @throws ParseException the parse exception
     */
    public ElementAvailability(List<TimeLimitAndVerticalTopology> policies, OptimizerRequest optimizerRequest,
                    TopologyResponse topologyResponse, ActiveTicketsResponse ticketResponse) throws ParseException {
        super(optimizerRequest, topologyResponse);
        this.policies         = policies;
        this.ticketResponse   = ticketResponse;
    }

    /**
     * Populate.
     *
     * @param parameters the parameters
     * @throws ParseException the parse exception
     */
    public void populate(OptimizerParameters parameters) throws ParseException {
        this.parameters = parameters;
        for (ChangeWindow changeWindow : optimizerRequest.getChangeWindows()) {
            if  (policies.size() > 0) {
                globalRelativeAvailability
                                .add(RecurringWindows.getAvailabilityWindowsForPolicies(policies, changeWindow));
            } else {
                List<ChangeWindow> wholeWindow = new ArrayList<>();
                wholeWindow.add(changeWindow);
                globalRelativeAvailability.add(wholeWindow);
            }
        }
        for (String id : nodeInfo.keySet()) {
            calculateNodeAvailability(nodeInfo.get(id));
        }
        setNoConflicts();
        parameters.setMaxTime(new Long(parameters.getNoConflict().get(0).size()));
        parameters.setNumElements(new Long(parameters.getNoConflict().size()));

        // for now we have 1 loader with unlimited capacity
        parameters.setNumLoaders(1L);
        Long loaderCapacity = parameters.getNumElements();
        List<Long> capacity =  new ArrayList<>();
        for (Long slot = 0L ; slot < parameters.getMaxTime() ; slot++) {
            capacity.add(loaderCapacity);
        }
        parameters.getLoaderCapacity().add(capacity);

        // For now every slot has the same concurrency limit
        capacity =  new ArrayList<>();
        Long limit = new Long(optimizerRequest.getConcurrencyLimit());
        if (limit > parameters.getNumElements()) {
            limit = parameters.getNumElements();
        }

        for (Long slot = 0L ; slot < parameters.getMaxTime() ; slot++) {
            capacity.add(limit);
        }
        parameters.setElementSlotCapacity(capacity);

    }

    private void setNoConflicts() throws ParseException {
        // Only support 1 change window for now
        ChangeWindow window = optimizerRequest.getChangeWindows().get(0);
        Long duration = new Long(optimizerRequest.getNormalDuration());
        if (optimizerRequest.getAdditionalDuration() != null) {
            duration += optimizerRequest.getAdditionalDuration();
        }
        for (String elementId : nodeInfo.keySet()) {

            TopologyElementInfo info = nodeInfo.get(elementId);
            // Library for lat/lon to timzezone is MIT license.
            // We must provided
            String timeZone = "GMT";
            if (info.getElementLocation() != null && info.getElementLocation().getTimezone() != null
                            && !info.getElementLocation().getTimezone().equals("")) {
                timeZone = info.getElementLocation().getTimezone();
            }
            DateTimeIterator recur = getRecurringIterator();
            List<Boolean> element = new ArrayList<>();
            // calculate number time slots
            long numberOfTimeSlots = calculateNumberOfSlotsInWindow(window, duration);
            while (recur.hasNext() && element.size() < numberOfTimeSlots) {
                DateTime next = recur.next();
                if (next.isAfter(window.getEndTime().getTime())) {
                    break;
                }
                ChangeWindow slot = new ChangeWindow();
                slot.setStartTime(next.toDate());
                slot.setEndTime(next.plus(duration).toDate());
                if (slotIsAvailable(slot, timeZone, nodeUnAvailability.get(elementId))) {
                    element.add(true);
                } else {
                    element.add(false);
                }
            }
            parameters.getNoConflict().add(element);
        }

    }

    private long calculateNumberOfSlotsInWindow(ChangeWindow window, Long duration) {
        long windowSize = window.getEndTime().getTime() - window.getStartTime().getTime();
        long numberOfSlots = windowSize / duration;
        return numberOfSlots;
    }

    private boolean slotIsAvailable(ChangeWindow slot, String timeZone, List<TicketData> tickets) {
        if (isGloballyAvailable(slot, timeZone) && isNotRestricted(slot, tickets)) {
            return true;
        }
        return false;
    }

    private boolean isNotRestricted(ChangeWindow slot, List<TicketData> tickets) {
        if (tickets != null) {
            for (TicketData ticket : tickets) {
                ChangeWindow window = new ChangeWindow();
                window.setStartTime(ticket.getStartTime());
                window.setEndTime(ticket.getEndTime());
                if (slot.overlaps(window)) {
                    return false;
                }
            }
        }
        return true;
    }

    //
    // Globally availability are generally maintenance window definitions
    // which are UTC times that are treated as relative to the local time zone.
    // The slot is an absolute UTCT time as well.
    // When we test to see if the slot is 'globally' available we must adjust it
    // to the local time of the element to see it it matches the relative
    // Consider
    // slot UTC time is 06:00-07:00
    // global availability (maintenance window) 00:00-06:00
    // the slot for an element in US/Eastern
    // time would be converted to 01:00-02:00
    // and would fit in the local maintenance window
    //
    private boolean isGloballyAvailable(ChangeWindow slot, String timeZone) {
        boolean available = false;
        for (ChangeWindow global : globalRelativeAvailability.get(0)) {
            if (global.containsInTimeZone(slot, timeZone)) {
                available = true;
            }
        }
        return available;
    }

    private void calculateNodeAvailability(TopologyElementInfo info) {
        Set<String> requiredElements = new HashSet<>();
        requiredElements.add(info.getElementId());
        if (info.getRequiredElements() != null) {
            requiredElements.addAll(info.getRequiredElements());
        }
        if (ticketResponse.getElements() != null) {
            List<TicketData> tickets = ticketResponse.getElements();
            for (TicketData data : tickets) {
                for (String id : data.getElementIds()) {
                    if (requiredElements.contains(id)) {
                        updateNodeAvailability(id, data);
                        break;
                    }
                }
            }
        }
    }

    private void updateNodeAvailability(String elementId, TicketData data) {
        List<TicketData> list = nodeUnAvailability.get(elementId);
        if (list == null) {
            list = new ArrayList<>();
            nodeUnAvailability.put(elementId, list);
        }
        list.add(data);
    }

}