aboutsummaryrefslogtreecommitdiffstats
path: root/config-model/src/test/java/com/yahoo/vespa/model/content/ClusterResourceLimitsTest.java
blob: 14e6efe7dffac58eb4ec8a6247b279d2bd7c7f83 (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
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
// Copyright Yahoo. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.vespa.model.content;

import com.yahoo.config.model.api.ModelContext;
import com.yahoo.config.model.deploy.TestProperties;
import com.yahoo.text.XML;
import com.yahoo.vespa.model.builder.xml.dom.ModelElement;
import org.junit.jupiter.api.Test;
import org.w3c.dom.Document;

import java.util.Optional;

import static org.junit.jupiter.api.Assertions.*;

/**
 * @author geirst
 */
public class ClusterResourceLimitsTest {

    private static class Fixture {
        private final boolean hostedVespa;
        private final ResourceLimits.Builder ctrlBuilder = new ResourceLimits.Builder();
        private final ResourceLimits.Builder nodeBuilder = new ResourceLimits.Builder();

        public Fixture() {
            this(false);
        }

        public Fixture(boolean hostedVespa) {
            this.hostedVespa = hostedVespa;
        }

        public Fixture ctrlDisk(double limit) {
            ctrlBuilder.setDiskLimit(limit);
            return this;
        }
        public Fixture ctrlMemory(double limit) {
            ctrlBuilder.setMemoryLimit(limit);
            return this;
        }
        public Fixture nodeDisk(double limit) {
            nodeBuilder.setDiskLimit(limit);
            return this;
        }
        public Fixture nodeMemory(double limit) {
            nodeBuilder.setMemoryLimit(limit);
            return this;
        }
        public ClusterResourceLimits build() {
            ModelContext.FeatureFlags featureFlags = new TestProperties();
            var builder = new ClusterResourceLimits.Builder(hostedVespa,
                                                            featureFlags.resourceLimitDisk(),
                                                            featureFlags.resourceLimitMemory());
            builder.setClusterControllerBuilder(ctrlBuilder);
            builder.setContentNodeBuilder(nodeBuilder);
            return builder.build();
        }
    }

    @Test
    void content_node_limits_are_derived_from_cluster_controller_limits_if_not_set() {
        assertLimits(0.4, 0.7, 0.76, 0.85,
                new Fixture().ctrlDisk(0.4).ctrlMemory(0.7));
        assertLimits(0.4, 0.8, 0.76, 0.9,
                new Fixture().ctrlDisk(0.4));
        assertLimits(0.75, 0.7, 0.9, 0.85,
                new Fixture().ctrlMemory(0.7));
    }

    @Test
    void content_node_limits_can_be_set_explicit() {
        assertLimits(0.4, 0.7, 0.9, 0.95,
                new Fixture().ctrlDisk(0.4).ctrlMemory(0.7).nodeDisk(0.9).nodeMemory(0.95));
        assertLimits(0.4, 0.8, 0.95, 0.9,
                new Fixture().ctrlDisk(0.4).nodeDisk(0.95));
        assertLimits(0.75, 0.7, 0.9, 0.95,
                new Fixture().ctrlMemory(0.7).nodeMemory(0.95));
    }

    @Test
    void cluster_controller_limits_are_equal_to_content_node_limits_minus_one_percent_if_not_set() {
        assertLimits(0.89, 0.94, 0.9, 0.95,
                new Fixture().nodeDisk(0.9).nodeMemory(0.95));
        assertLimits(0.89, 0.8, 0.9, 0.9,
                new Fixture().nodeDisk(0.9));
        assertLimits(0.75, 0.94, 0.9, 0.95,
                new Fixture().nodeMemory(0.95));
        assertLimits(0.75, 0.0, 0.9, 0.005,
                new Fixture().nodeMemory(0.005));
    }

    @Test
    void limits_are_derived_from_the_other_if_not_set() {
        assertLimits(0.6, 0.94, 0.84, 0.95,
                new Fixture().ctrlDisk(0.6).nodeMemory(0.95));
        assertLimits(0.89, 0.7, 0.9, 0.85,
                new Fixture().ctrlMemory(0.7).nodeDisk(0.9));
    }

    @Test
    void default_resource_limits_when_feed_block_is_enabled_in_distributor() {
        assertLimits(0.75, 0.8, 0.9, 0.9,
                new Fixture(true));
    }

    @Test
    void hosted_exception_is_thrown_when_resource_limits_are_specified() {
        try {
            hostedBuild();
            fail();
        } catch (IllegalArgumentException e) {
            assertTrue(e.getMessage().contains("Element 'resource-limits' is not allowed to be set"));
        }
    }

    @Test
    void hosted_limits_from_feature_flag_are_used() {
        TestProperties featureFlags = new TestProperties();
        featureFlags.setResourceLimitDisk(0.85);
        featureFlags.setResourceLimitMemory(0.90);
        var limits = hostedBuild(featureFlags, false);

        // Verify that limits from feature flags are used
        assertLimits(0.85, 0.90, limits.getClusterControllerLimits());
        assertLimits(0.94, 0.95, limits.getContentNodeLimits());
    }

    @Test
    void exception_is_thrown_when_resource_limits_are_out_of_range() {
        TestProperties featureFlags = new TestProperties();
        featureFlags.setResourceLimitDisk(1.1);

        try {
            hostedBuild(featureFlags, false);
            fail();
        } catch (IllegalArgumentException e) {
            assertTrue(e.getMessage().contains("Resource limit for disk is set to illegal value 1.1, but must be in the range [0.0, 1.0]"));
        }

        featureFlags = new TestProperties();
        featureFlags.setResourceLimitDisk(-0.1);
        try {
            hostedBuild(featureFlags, false);
            fail();
        } catch (IllegalArgumentException e) {
            assertTrue(e.getMessage().contains("Resource limit for disk is set to illegal value -0.1, but must be in the range [0.0, 1.0]"));
        }
    }

    private ClusterResourceLimits hostedBuild() {
        return hostedBuild(new TestProperties(), true);
    }

    private ClusterResourceLimits hostedBuild(ModelContext.FeatureFlags featureFlags,
                                              boolean limitsInXml) {
        Document clusterXml = XML.getDocument("<cluster id=\"test\">" +
                                              "  <tuning>\n" +
                                              "    <resource-limits>\n" +
                                              "      <memory>0.92</memory>\n" +
                                              "    </resource-limits>\n" +
                                              "  </tuning>\n" +
                                              "</cluster>");

        Document noLimitsXml = XML.getDocument("<cluster id=\"test\">" +
                                              "</cluster>");

        ClusterResourceLimits.Builder builder = new ClusterResourceLimits.Builder(true,
                                                                                  featureFlags.resourceLimitDisk(),
                                                                                  featureFlags.resourceLimitMemory());
        return builder.build(new ModelElement((limitsInXml ? clusterXml : noLimitsXml).getDocumentElement()));
    }

    private void assertLimits(Double expCtrlDisk, Double expCtrlMemory, Double expNodeDisk, Double expNodeMemory, Fixture f) {
        var limits = f.build();
        assertLimits(expCtrlDisk, expCtrlMemory, limits.getClusterControllerLimits());
        assertLimits(expNodeDisk, expNodeMemory, limits.getContentNodeLimits());
    }

    private void assertLimits(Double expDisk, Double expMemory, ResourceLimits limits) {
        assertLimit(expDisk, limits.getDiskLimit(), "disk");
        assertLimit(expMemory, limits.getMemoryLimit(), "memory");
    }

    private void assertLimit(Double expLimit, Optional<Double> actLimit, String limitType) {
        if (expLimit == null) {
            assertFalse(actLimit.isPresent());
        } else {
            assertEquals(expLimit, actLimit.get(), 0.00001, limitType + " limit not as expected");
        }
    }

}