Fix typos and improve javadocs on ByteScaleUtils (apache#6877)

GutoVeronezi · GutoVeronezi · web-flow · commit b8b66b7a3db5 · 2022-11-10T10:14:24.000+01:00
Co-authored-by: GutoVeronezi &lt;daniel@scclouds.com.br&gt;
diff --git a/framework/quota/src/main/java/org/apache/cloudstack/quota/activationrule/presetvariables/PresetVariableHelper.java b/framework/quota/src/main/java/org/apache/cloudstack/quota/activationrule/presetvariables/PresetVariableHelper.java
@@ -469,7 +469,7 @@ protected void loadPresetVariableValueForVolume(UsageVO usageRecord, Value value
         }
 
         value.setTags(getPresetVariableValueResourceTags(volumeId, ResourceObjectType.Volume));
-        value.setSize(ByteScaleUtils.bytesToMib(volumeVo.getSize()));
+        value.setSize(ByteScaleUtils.bytesToMebibytes(volumeVo.getSize()));
     }
 
     protected GenericPresetVariable getPresetVariableValueDiskOffering(Long diskOfferingId) {
@@ -536,7 +536,7 @@ protected void loadPresetVariableValueForTemplateAndIso(UsageVO usageRecord, Val
         value.setName(vmTemplateVo.getName());
         value.setOsName(getPresetVariableValueOsName(vmTemplateVo.getGuestOSId()));
         value.setTags(getPresetVariableValueResourceTags(templateOrIsoId, usageType == UsageTypes.ISO ? ResourceObjectType.ISO : ResourceObjectType.Template));
-        value.setSize(ByteScaleUtils.bytesToMib(vmTemplateVo.getSize()));
+        value.setSize(ByteScaleUtils.bytesToMebibytes(vmTemplateVo.getSize()));
     }
 
     protected void loadPresetVariableValueForSnapshot(UsageVO usageRecord, Value value) {
@@ -554,7 +554,7 @@ protected void loadPresetVariableValueForSnapshot(UsageVO usageRecord, Value val
 
         value.setId(snapshotVo.getUuid());
         value.setName(snapshotVo.getName());
-        value.setSize(ByteScaleUtils.bytesToMib(snapshotVo.getSize()));
+        value.setSize(ByteScaleUtils.bytesToMebibytes(snapshotVo.getSize()));
         value.setSnapshotType(Snapshot.Type.values()[snapshotVo.getSnapshotType()]);
         value.setStorage(getPresetVariableValueStorage(getSnapshotDataStoreId(snapshotId), usageType));
         value.setTags(getPresetVariableValueResourceTags(snapshotId, ResourceObjectType.Snapshot));
diff --git a/framework/quota/src/test/java/org/apache/cloudstack/quota/activationrule/presetvariables/PresetVariableHelperTest.java b/framework/quota/src/test/java/org/apache/cloudstack/quota/activationrule/presetvariables/PresetVariableHelperTest.java
@@ -657,7 +657,7 @@ public void loadPresetVariableValueForVolumeTestRecordIsVolumeAndHasStorageSetFi
         Value result = new Value();
         presetVariableHelperSpy.loadPresetVariableValueForVolume(usageVoMock, result);
 
-        Long expectedSize = ByteScaleUtils.bytesToMib(expected.getSize());
+        Long expectedSize = ByteScaleUtils.bytesToMebibytes(expected.getSize());
 
         assertPresetVariableIdAndName(expected, result);
         Assert.assertEquals(expected.getDiskOffering(), result.getDiskOffering());
@@ -693,7 +693,7 @@ public void loadPresetVariableValueForVolumeTestRecordIsVolumeAndDoesNotHaveStor
         Value result = new Value();
         presetVariableHelperSpy.loadPresetVariableValueForVolume(usageVoMock, result);
 
-        Long expectedSize = ByteScaleUtils.bytesToMib(expected.getSize());
+        Long expectedSize = ByteScaleUtils.bytesToMebibytes(expected.getSize());
 
         assertPresetVariableIdAndName(expected, result);
         Assert.assertEquals(expected.getDiskOffering(), result.getDiskOffering());
@@ -824,7 +824,7 @@ public void loadPresetVariableValueForTemplateAndIsoTestRecordIsVolumeSetFields(
             Value result = new Value();
             presetVariableHelperSpy.loadPresetVariableValueForTemplateAndIso(usageVoMock, result);
 
-            Long expectedSize = ByteScaleUtils.bytesToMib(expected.getSize());
+            Long expectedSize = ByteScaleUtils.bytesToMebibytes(expected.getSize());
 
             assertPresetVariableIdAndName(expected, result);
             Assert.assertEquals(expected.getOsName(), result.getOsName());
@@ -872,7 +872,7 @@ public void loadPresetVariableValueForSnapshotTestRecordIsSnapshotSetFields() {
         Value result = new Value();
         presetVariableHelperSpy.loadPresetVariableValueForSnapshot(usageVoMock, result);
 
-        Long expectedSize = ByteScaleUtils.bytesToMib(expected.getSize());
+        Long expectedSize = ByteScaleUtils.bytesToMebibytes(expected.getSize());
 
         assertPresetVariableIdAndName(expected, result);
         Assert.assertEquals(expected.getSnapshotType(), result.getSnapshotType());
diff --git a/plugins/hypervisors/kvm/src/main/java/com/cloud/hypervisor/kvm/resource/LibvirtComputingResource.java b/plugins/hypervisors/kvm/src/main/java/com/cloud/hypervisor/kvm/resource/LibvirtComputingResource.java
@@ -2814,7 +2814,7 @@ protected GuestResourceDef createGuestResourceDef(VirtualMachineTO vmTO){
 
         grd.setMemBalloning(!_noMemBalloon);
 
-        Long maxRam = ByteScaleUtils.bytesToKib(vmTO.getMaxRam());
+        Long maxRam = ByteScaleUtils.bytesToKibibytes(vmTO.getMaxRam());
 
         grd.setMemorySize(maxRam);
         grd.setCurrentMem(getCurrentMemAccordingToMemBallooning(vmTO, maxRam));
@@ -2833,7 +2833,7 @@ protected long getCurrentMemAccordingToMemBallooning(VirtualMachineTO vmTO, long
             s_logger.warn(String.format("Setting VM's [%s] current memory as max memory [%s] due to memory ballooning is disabled. If you are using a custom service offering, verify if memory ballooning really should be disabled.", vmTO.toString(), maxRam));
             return maxRam;
         } else {
-            return ByteScaleUtils.bytesToKib(vmTO.getMinRam());
+            return ByteScaleUtils.bytesToKibibytes(vmTO.getMinRam());
         }
     }
 
diff --git a/plugins/hypervisors/kvm/src/main/java/com/cloud/hypervisor/kvm/resource/wrapper/LibvirtScaleVmCommandWrapper.java b/plugins/hypervisors/kvm/src/main/java/com/cloud/hypervisor/kvm/resource/wrapper/LibvirtScaleVmCommandWrapper.java
@@ -37,7 +37,7 @@ public Answer execute(ScaleVmCommand command, LibvirtComputingResource libvirtCo
         String vmName = vmSpec.getName();
         Connect conn = null;
 
-        long newMemory = ByteScaleUtils.bytesToKib(vmSpec.getMaxRam());
+        long newMemory = ByteScaleUtils.bytesToKibibytes(vmSpec.getMaxRam());
         int newVcpus = vmSpec.getCpus();
         int newCpuSpeed = vmSpec.getMinSpeed() != null ? vmSpec.getMinSpeed() : vmSpec.getSpeed();
         int newCpuShares = newVcpus * newCpuSpeed;
diff --git a/plugins/hypervisors/kvm/src/test/java/com/cloud/hypervisor/kvm/resource/LibvirtComputingResourceTest.java b/plugins/hypervisors/kvm/src/test/java/com/cloud/hypervisor/kvm/resource/LibvirtComputingResourceTest.java
@@ -5756,13 +5756,13 @@ public void validateGetCurrentMemAccordingToMemBallooningWithtMemBalooning(){
         libvirtComputingResource._noMemBalloon = false;
 
         long maxMemory = 2048;
-        long minMemory = ByteScaleUtils.mibToBytes(64);
+        long minMemory = ByteScaleUtils.mebibytesToBytes(64);
 
         VirtualMachineTO vmTo = Mockito.mock(VirtualMachineTO.class);
         Mockito.when(vmTo.getMinRam()).thenReturn(minMemory);
 
         long currentMemory = libvirtComputingResource.getCurrentMemAccordingToMemBallooning(vmTo, maxMemory);
-        Assert.assertEquals(ByteScaleUtils.bytesToKib(minMemory), currentMemory);
+        Assert.assertEquals(ByteScaleUtils.bytesToKibibytes(minMemory), currentMemory);
         Mockito.verify(vmTo).getMinRam();
     }
 
diff --git a/plugins/hypervisors/kvm/src/test/java/com/cloud/hypervisor/kvm/resource/wrapper/LibvirtScaleVmCommandWrapperTest.java b/plugins/hypervisors/kvm/src/test/java/com/cloud/hypervisor/kvm/resource/wrapper/LibvirtScaleVmCommandWrapperTest.java
@@ -76,7 +76,7 @@ public void init() {
 
         vmTo = new VirtualMachineTO(1, "Test 1", VirtualMachine.Type.User, 2, 1000, 67108864, 67108864, VirtualMachineTemplate.BootloaderType.External, "Other Linux (64x)", true, true, "test123");
 
-        long memory = ByteScaleUtils.bytesToKib(vmTo.getMaxRam());
+        long memory = ByteScaleUtils.bytesToKibibytes(vmTo.getMaxRam());
         int vcpus = vmTo.getCpus();
         int cpuShares = vcpus * vmTo.getSpeed();
         scalingDetails = String.format("%s memory to [%s KiB], CPU cores to [%s] and cpu_shares to [%s]", vmTo.toString(), memory, vcpus, cpuShares);
diff --git a/server/src/main/java/com/cloud/hypervisor/KVMGuru.java b/server/src/main/java/com/cloud/hypervisor/KVMGuru.java
@@ -220,15 +220,15 @@ protected Long getVmMaxMemory(ServiceOfferingVO serviceOfferingVO, String vmDesc
         Integer maxMemoryConfig = ConfigurationManagerImpl.VM_SERVICE_OFFERING_MAX_RAM_SIZE.value();
         if (customOfferingMaxMemory != null) {
             s_logger.debug(String.format("Using 'Custom unconstrained' %s max memory value [%sMb] as %s memory.", serviceOfferingDescription, customOfferingMaxMemory, vmDescription));
-            maxMemory = ByteScaleUtils.mibToBytes(customOfferingMaxMemory);
+            maxMemory = ByteScaleUtils.mebibytesToBytes(customOfferingMaxMemory);
         } else {
             String maxMemoryConfigKey = ConfigurationManagerImpl.VM_SERVICE_OFFERING_MAX_RAM_SIZE.key();
 
             s_logger.info(String.format("%s is a 'Custom unconstrained' service offering. Using config [%s] value [%s] as max %s memory.",
               serviceOfferingDescription, maxMemoryConfigKey, maxMemoryConfig, vmDescription));
 
             if (maxMemoryConfig > 0) {
-                maxMemory = ByteScaleUtils.mibToBytes(maxMemoryConfig);
+                maxMemory = ByteScaleUtils.mebibytesToBytes(maxMemoryConfig);
             } else {
                 s_logger.info(String.format("Config [%s] has value less or equal '0'. Using %s host or last host max memory [%s] as VM max memory in the hypervisor.", maxMemoryConfigKey, vmDescription, maxHostMemory));
                 maxMemory = maxHostMemory;
diff --git a/server/src/main/java/com/cloud/vm/UserVmManagerImpl.java b/server/src/main/java/com/cloud/vm/UserVmManagerImpl.java
@@ -2053,7 +2053,7 @@ private boolean upgradeRunningVirtualMachine(Long vmId, Long newServiceOfferingI
                     // #1 Check existing host has capacity
                     if (!excludes.shouldAvoid(ApiDBUtils.findHostById(vmInstance.getHostId()))) {
                         existingHostHasCapacity = _capacityMgr.checkIfHostHasCpuCapability(vmInstance.getHostId(), newCpu, newSpeed)
-                                && _capacityMgr.checkIfHostHasCapacity(vmInstance.getHostId(), cpuDiff, ByteScaleUtils.mibToBytes(memoryDiff), false,
+                                && _capacityMgr.checkIfHostHasCapacity(vmInstance.getHostId(), cpuDiff, ByteScaleUtils.mebibytesToBytes(memoryDiff), false,
                                         _capacityMgr.getClusterOverProvisioningFactor(host.getClusterId(), Capacity.CAPACITY_TYPE_CPU),
                                         _capacityMgr.getClusterOverProvisioningFactor(host.getClusterId(), Capacity.CAPACITY_TYPE_MEMORY), false);
                         excludes.addHost(vmInstance.getHostId());
diff --git a/server/src/test/java/com/cloud/hypervisor/KVMGuruTest.java b/server/src/test/java/com/cloud/hypervisor/KVMGuruTest.java
@@ -176,7 +176,7 @@ public void validateGetVmMaxMemoryReturnCustomOfferingMaxMemory(){
 
         long result = guru.getVmMaxMemory(serviceOfferingVoMock, "Vm description", 1l);
 
-        Assert.assertEquals(ByteScaleUtils.mibToBytes(maxCustomOfferingMemory), result);
+        Assert.assertEquals(ByteScaleUtils.mebibytesToBytes(maxCustomOfferingMemory), result);
     }
 
     @Test
@@ -190,12 +190,12 @@ public void validateGetVmMaxMemoryReturnVmServiceOfferingMaxRAMSize(){
         Mockito.when(vmServiceOfferingMaxRAMSize.value()).thenReturn(maxMemoryConfig);
         long result = guru.getVmMaxMemory(serviceOfferingVoMock, "Vm description", 1l);
 
-        Assert.assertEquals(ByteScaleUtils.mibToBytes(maxMemoryConfig), result);
+        Assert.assertEquals(ByteScaleUtils.mebibytesToBytes(maxMemoryConfig), result);
     }
 
     @Test
     public void validateGetVmMaxMemoryReturnMaxHostMemory(){
-        long maxHostMemory = ByteScaleUtils.mibToBytes(2000);
+        long maxHostMemory = ByteScaleUtils.mebibytesToBytes(2000);
         Mockito.when(serviceOfferingVoMock.getDetail(ApiConstants.MAX_MEMORY)).thenReturn(null);
 
         ConfigKey<Integer> vmServiceOfferingMaxRAMSize = Mockito.mock(ConfigKey.class);
@@ -490,4 +490,4 @@ public void testGetNullWhenVMThereIsNoInformationOfUsedHosts() {
 
         Assert.assertNull(clusterId);
     }
-}
+}
diff --git a/utils/src/main/java/org/apache/cloudstack/utils/bytescale/ByteScaleUtils.java b/utils/src/main/java/org/apache/cloudstack/utils/bytescale/ByteScaleUtils.java
@@ -15,7 +15,7 @@
 package org.apache.cloudstack.utils.bytescale;
 
 /**
- * This class provides a facility to convert bytes through his scales (b, Kib, Kb, Mib, Mb...).
+ * This class provides a facility to convert bytes through the scales (B, KiB, KB, MiB, MB...).
  *
  */
 public class ByteScaleUtils {
@@ -30,29 +30,29 @@ private ByteScaleUtils() {}
      * Converts mebibytes to bytes.
      *
      * @param mib The value to convert to bytes (eq: 1, 2, 3, ..., 42,...).
-     * @return The parameter multiplied by 1048576 (1024 * 1024, 1 MiB).
+     * @return The parameter multiplied by 2²⁰ (1048576 | 1024 * 1024 | 1 mebibyte).
      */
-    public static long mibToBytes(long mib) {
+    public static long mebibytesToBytes(long mib) {
         return mib * MiB;
     }
 
     /**
-     * Converts bytes to kibibytes.
+     * Converts bytes to kibibyte.
      *
-     * @param b The value in bytes to convert to kibibytes.
-     * @return The parameter divided by 1024 (1 KiB).
+     * @param bytes The value in bytes to convert to kibibyte.
+     * @return The parameter divided by 2¹⁰ (1024 | 1 kibibyte).
      */
-    public static long bytesToKib(long b) {
-        return b / KiB;
+    public static long bytesToKibibytes(long bytes) {
+        return bytes / KiB;
     }
 
     /**
      * Converts bytes to mebibytes.
      *
-     * @param b The value in bytes to convert to mebibytes.
-     * @return The parameter divided by 1024 * 1024 (1 MiB).
+     * @param bytes The value in bytes to convert to mebibytes.
+     * @return The parameter divided by 2²⁰ (1048576 | 1024 * 1024 | 1 mebibyte).
      */
-    public static long bytesToMib(long b) {
-        return b / MiB;
+    public static long bytesToMebibytes(long bytes) {
+        return bytes / MiB;
     }
 }
diff --git a/utils/src/test/java/org/apache/cloudstack/utils/bytescale/ByteScaleUtilsTest.java b/utils/src/test/java/org/apache/cloudstack/utils/bytescale/ByteScaleUtilsTest.java
@@ -14,45 +14,45 @@
 
 package org.apache.cloudstack.utils.bytescale;
 
-import junit.framework.TestCase;
+import org.junit.Assert;
 import org.junit.Test;
 import org.junit.runner.RunWith;
 import org.mockito.junit.MockitoJUnitRunner;
 
 @RunWith(MockitoJUnitRunner.class)
-public class ByteScaleUtilsTest extends TestCase {
+public class ByteScaleUtilsTest {
 
     @Test
-    public void validateMibToBytes() {
+    public void validateMebibytesToBytes() {
         long mib = 3000L;
-        long b = 1024L * 1024L * mib;
-        assertEquals(b, ByteScaleUtils.mibToBytes(mib));
+        long bytes = 1024L * 1024L * mib;
+        Assert.assertEquals(bytes, ByteScaleUtils.mebibytesToBytes(mib));
     }
 
     @Test
-    public void validateBytesToKib() {
+    public void validateBytesToKibibytes() {
         long kib = 3000L;
-        long b = 1024 * kib;
-        assertEquals(kib, ByteScaleUtils.bytesToKib(b));
+        long bytes = 1024 * kib;
+        Assert.assertEquals(kib, ByteScaleUtils.bytesToKibibytes(bytes));
     }
 
     @Test
-    public void validateBytesToMib() {
+    public void validateBytesToMebibytes() {
         long mib = 3000L;
-        long b = 1024L * 1024L * mib;
-        assertEquals(mib, ByteScaleUtils.bytesToMib(b));
+        long bytes = 1024L * 1024L * mib;
+        Assert.assertEquals(mib, ByteScaleUtils.bytesToMebibytes(bytes));
     }
 
     @Test
-    public void validateMibToBytesIfIntTimesIntThenMustExtrapolateIntMaxValue() {
+    public void validateMebibytesToBytesIfIntTimesIntThenMustExtrapolateIntMaxValue() {
         int mib = 3000;
-        long b = 1024L * 1024L * mib;
-        assertEquals(b, ByteScaleUtils.mibToBytes(mib));
+        long bytes = 1024L * 1024L * mib;
+        Assert.assertEquals(bytes, ByteScaleUtils.mebibytesToBytes(mib));
     }
 
     @Test
-    public void validateBytesToKibIfIntByIntThenMustExtrapolateIntMaxValue(){
-        int b = Integer.MAX_VALUE;
-        assertEquals(b, ByteScaleUtils.bytesToKib(b * 1024L));
+    public void validateBytesToKibibytesIfIntByIntThenMustExtrapolateIntMaxValue(){
+        int bytes = Integer.MAX_VALUE;
+        Assert.assertEquals(bytes, ByteScaleUtils.bytesToKibibytes(bytes * 1024L));
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -2814,7 +2814,7 @@ protected GuestResourceDef createGuestResourceDef(VirtualMachineTO vmTO){`
`2814`	`2814`
`2815`	`2815`	`grd.setMemBalloning(!_noMemBalloon);`
`2816`	`2816`
`2817`		`- Long maxRam = ByteScaleUtils.bytesToKib(vmTO.getMaxRam());`
	`2817`	`+ Long maxRam = ByteScaleUtils.bytesToKibibytes(vmTO.getMaxRam());`
`2818`	`2818`
`2819`	`2819`	`grd.setMemorySize(maxRam);`
`2820`	`2820`	`grd.setCurrentMem(getCurrentMemAccordingToMemBallooning(vmTO, maxRam));`
`@@ -2833,7 +2833,7 @@ protected long getCurrentMemAccordingToMemBallooning(VirtualMachineTO vmTO, long`
`2833`	`2833`	`s_logger.warn(String.format("Setting VM's [%s] current memory as max memory [%s] due to memory ballooning is disabled. If you are using a custom service offering, verify if memory ballooning really should be disabled.", vmTO.toString(), maxRam));`
`2834`	`2834`	`return maxRam;`
`2835`	`2835`	`} else {`
`2836`		`- return ByteScaleUtils.bytesToKib(vmTO.getMinRam());`
	`2836`	`+ return ByteScaleUtils.bytesToKibibytes(vmTO.getMinRam());`
`2837`	`2837`	`}`
`2838`	`2838`	`}`
`2839`	`2839`