alert messages restructure #13775
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,45 @@ | ||
| // Licensed to the Apache Software Foundation (ASF) under one | ||
| // or more contributor license agreements. See the NOTICE file | ||
| // distributed with this work for additional information | ||
| // regarding copyright ownership. The ASF licenses this file | ||
| // to you 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. | ||
| package com.cloud.alert; | ||
|
|
||
| import com.cloud.dc.DataCenter; | ||
| import com.cloud.dc.Pod; | ||
| import com.cloud.host.Host; | ||
|
|
||
| /** | ||
| * Shared formatting for the host/zone/pod description that recurs, independently | ||
| * hand-rolled and inconsistently worded (and occasionally mislabelled), across the | ||
| * HA and agent-management alert call sites. See CLOUDSTACK-7297. | ||
| */ | ||
| public final class AlertFormatUtils { | ||
|
|
||
| private AlertFormatUtils() { | ||
| } | ||
|
|
||
| public static String describeHostLocation(Host host, DataCenter zone, Pod pod) { | ||
| if (host == null) { | ||
| // we should never get here, but if we do, at least we won't get an NPE | ||
| return String.format("No host to describe for availability zone: %s, pod: %s", | ||
| zone != null ? zone.getName() : "unknown", | ||
| pod != null ? pod.getName() : "unknown"); | ||
| } | ||
| return String.format("name: %s (id: %d, uuid: %s), availability zone: %s, pod: %s", | ||
| host.getName(), host.getId(), host.getUuid(), | ||
| zone != null ? zone.getName() : "unknown", | ||
| pod != null ? pod.getName() : "unknown"); | ||
| } | ||
|
DaanHoogland marked this conversation as resolved.
|
||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,111 @@ | ||
| // Licensed to the Apache Software Foundation (ASF) under one | ||
| // or more contributor license agreements. See the NOTICE file | ||
| // distributed with this work for additional information | ||
| // regarding copyright ownership. The ASF licenses this file | ||
| // to you 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. | ||
| package com.cloud.alert; | ||
|
|
||
| import static org.junit.Assert.assertEquals; | ||
| import static org.mockito.Mockito.when; | ||
|
|
||
| import org.junit.Test; | ||
| import org.junit.runner.RunWith; | ||
| import org.mockito.Mock; | ||
| import org.mockito.junit.MockitoJUnitRunner; | ||
|
|
||
| import com.cloud.dc.DataCenter; | ||
| import com.cloud.dc.Pod; | ||
| import com.cloud.host.Host; | ||
|
|
||
| @RunWith(MockitoJUnitRunner.class) | ||
| public class AlertFormatUtilsTest { | ||
|
|
||
| @Mock | ||
| Host host; | ||
| @Mock | ||
| DataCenter zone; | ||
| @Mock | ||
| Pod pod; | ||
|
|
||
| @Test | ||
| public void describeHostLocationIncludesNameIdUuidZoneAndPod() { | ||
| setUpHost(); | ||
| setUpZone(); | ||
| setUpPod(); | ||
|
|
||
| String result = AlertFormatUtils.describeHostLocation(host, zone, pod); | ||
|
|
||
| assertEquals("name: cs-kvm06 (id: 37, uuid: host-uuid), availability zone: Milton1, pod: Milton1-Pod1", result); | ||
| } | ||
|
|
||
| @Test | ||
| public void describeHostLocationFallsBackToUnknownForNullZone() { | ||
| setUpHost(); | ||
| setUpPod(); | ||
|
|
||
| String result = AlertFormatUtils.describeHostLocation(host, null, pod); | ||
|
|
||
| assertEquals("name: cs-kvm06 (id: 37, uuid: host-uuid), availability zone: unknown, pod: Milton1-Pod1", result); | ||
| } | ||
|
|
||
| @Test | ||
| public void describeHostLocationFallsBackToUnknownForNullPod() { | ||
| setUpHost(); | ||
| setUpZone(); | ||
|
|
||
| String result = AlertFormatUtils.describeHostLocation(host, zone, null); | ||
|
|
||
| assertEquals("name: cs-kvm06 (id: 37, uuid: host-uuid), availability zone: Milton1, pod: unknown", result); | ||
| } | ||
|
|
||
| @Test | ||
| public void describeHostLocationFallsBackToUnknownForNullZoneAndPod() { | ||
| setUpHost(); | ||
|
|
||
| String result = AlertFormatUtils.describeHostLocation(host, null, null); | ||
|
|
||
| assertEquals("name: cs-kvm06 (id: 37, uuid: host-uuid), availability zone: unknown, pod: unknown", result); | ||
| } | ||
|
|
||
| @Test | ||
| public void describeHostLocationDescribesZoneAndPodForNullHost() { | ||
| setUpZone(); | ||
| setUpPod(); | ||
|
|
||
| String result = AlertFormatUtils.describeHostLocation(null, zone, pod); | ||
|
|
||
| assertEquals("No host to describe for availability zone: Milton1, pod: Milton1-Pod1", result); | ||
| } | ||
|
|
||
| @Test | ||
| public void describeHostLocationFallsBackToUnknownForNullHostAndNullZoneAndPod() { | ||
| String result = AlertFormatUtils.describeHostLocation(null, null, null); | ||
|
|
||
| assertEquals("No host to describe for availability zone: unknown, pod: unknown", result); | ||
| } | ||
|
|
||
| private void setUpHost() { | ||
| when(host.getName()).thenReturn("cs-kvm06"); | ||
| when(host.getId()).thenReturn(37L); | ||
| when(host.getUuid()).thenReturn("host-uuid"); | ||
| } | ||
|
|
||
| private void setUpZone() { | ||
| when(zone.getName()).thenReturn("Milton1"); | ||
| } | ||
|
|
||
| private void setUpPod() { | ||
| when(pod.getName()).thenReturn("Milton1-Pod1"); | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.