Merge pull request #89 from ie3-institute/ck/#88-fixUnitImplementation

Fix malicious implementation of units

Author: johanneshiry

CHANGELOG.md

@@ -6,6 +6,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased/Snapshot]
 
+## [1.5.1]
+### Fixed
+-   Malicious implementation of some units + additional tests for transformed units
+
 ## [1.5]
 
 ### Added
@@ -57,7 +61,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Fixed
 -   fixes + extensions in StandardUnits
 
-[Unreleased/Snapshot]: https://github.com/ie3-institute/powersystemutils/compare/v1.5...HEAD
+[Unreleased/Snapshot]: https://github.com/ie3-institute/powersystemutils/compare/v1.5.1...HEAD
+[1.5.1]: https://github.com/ie3-institute/powersystemutils/compare/v1.4...v1.5.1
 [1.5]: https://github.com/ie3-institute/powersystemutils/compare/v1.4...v1.5
 [1.4]: https://github.com/ie3-institute/powersystemutils/compare/v1.3.2...v1.4
 [1.3.2]: https://github.com/ie3-institute/powersystemutils/compare/v1.3.1...v1.3.2

build.gradle

@@ -20,7 +20,7 @@ ext {
 }
 
 group = 'com.github.ie3-institute'
-version = '1.6-SNAPSHOT'
+version = '1.5.1'
 description = 'PowerSystemUtils'
 sourceCompatibility = javaVersion
 targetCompatibility = javaVersion

src/main/java/edu/ie3/util/quantities/PowerSystemUnits.java

@@ -46,19 +46,19 @@ public class PowerSystemUnits extends Units {
 
   /** Euro / km */
   public static final Unit<PricePerLength> EURO_PER_KILOMETRE =
-      new ProductUnit<>(EURO.divide(MetricPrefix.KILO(METRE)));
+      new ProductUnit<>(EURO.divide(KILOMETRE));
 
   /** Euro / Wh */
   public static final Unit<EnergyPrice> EURO_PER_WATTHOUR =
-      new ProductUnit<>(EURO.divide(Units.WATT.multiply(Units.HOUR)));
+      new ProductUnit<>(EURO.divide(WATT.multiply(HOUR)));
 
   /** Euro / kWh */
   public static final Unit<EnergyPrice> EURO_PER_KILOWATTHOUR =
-      MetricPrefix.MILLI(EURO_PER_WATTHOUR);
+      new TransformedUnit<>("€/kWh", EURO_PER_WATTHOUR, MultiplyConverter.of(1E-3));
 
   /** Euro / MWh */
   public static final Unit<EnergyPrice> EURO_PER_MEGAWATTHOUR =
-      MetricPrefix.MICRO(EURO_PER_WATTHOUR);
+      new TransformedUnit<>("€/MWh", EURO_PER_WATTHOUR, MultiplyConverter.of(1E-6));
 
   /** Degree */
   public static final Unit<Angle> DEGREE_GEOM =
@@ -83,11 +83,12 @@ public class PowerSystemUnits extends Units {
   public static final Unit<Energy> KILOVARHOUR = MetricPrefix.KILO(VARHOUR);
 
   /** Watthour per metre */
-  public static final Unit<SpecificEnergy> WATTHOUR_PER_METRE = new BaseUnit<>("Wh/m");
+  public static final Unit<SpecificEnergy> WATTHOUR_PER_METRE =
+      new ProductUnit<>(WATTHOUR.divide(METRE));
 
   /** Kilowatthour per Kilometre */
   public static final Unit<SpecificEnergy> KILOWATTHOUR_PER_KILOMETRE =
-      new AlternateUnit<>(WATTHOUR_PER_METRE, "kWh/km");
+      new TransformedUnit<>("kWh/km", WATTHOUR_PER_METRE, MultiplyConverter.of(1d));
 
   /** Watthour per squaremetre */
   public static final Unit<Irradiation> WATTHOUR_PER_SQUAREMETRE =
@@ -159,7 +160,8 @@ public class PowerSystemUnits extends Units {
       new ProductUnit<>(MetricPrefix.MICRO(SIEMENS).divide(KILOMETRE));
 
   /** Farad per metre */
-  public static final Unit<SpecificCapacitance> FARAD_PER_METRE = new BaseUnit<>("F/m");
+  public static final Unit<SpecificCapacitance> FARAD_PER_METRE =
+      new ProductUnit<>(FARAD.divide(METRE));
 
   /** F / km */
   public static final Unit<SpecificCapacitance> FARAD_PER_KILOMETRE =
@@ -181,9 +183,10 @@ public class PowerSystemUnits extends Units {
   /* ==== Thermal Conductance ==== */
 
   /** kW/K */
-  public static final Unit<ThermalConductance> KILOWATT_PER_KELVIN = new BaseUnit<>("kW/K");
+  public static final Unit<ThermalConductance> KILOWATT_PER_KELVIN =
+      new ProductUnit<>(KILOWATT.divide(KELVIN));
 
-  private static final HashSet<String> registeredLabels = new HashSet<>();
+  private static final HashSet<String> REGISTERED_LABELS = new HashSet<>();
 
   static {
     addUnit(WATTHOUR, "Wh");
@@ -221,12 +224,13 @@ public class PowerSystemUnits extends Units {
    * return-value is null, the unit was already registered
    */
   private static Unit<?> addUnit(Unit<?> unit, String label) {
-    if (registeredLabels.contains(label)) {
+    if (REGISTERED_LABELS.contains(label)) {
       logger.log(Level.FINE, "Label {} is already registered. Ignoring", label);
       return null;
     }
 
     SimpleUnitFormat.getInstance().label(unit, label);
+    REGISTERED_LABELS.add(label);
     return unit;
   }
 }

src/test/groovy/edu/ie3/util/quantities/PowerSystemUnitsTest.groovy

@@ -5,17 +5,45 @@
  */
 package edu.ie3.util.quantities
 
+import spock.lang.Shared
 import spock.lang.Specification
 import tech.units.indriya.quantity.Quantities
-import tech.units.indriya.unit.Units
+
+import static edu.ie3.util.quantities.PowerSystemUnits.*
+import static tech.units.indriya.unit.Units.JOULE
+import static tech.units.indriya.unit.Units.RADIAN
 
 class PowerSystemUnitsTest extends Specification {
+	@Shared
+	double testingTolerance = 1E-9
+
+	def "Transformed units are transferred correctly to their base units"() {
+		when:
+		def actualQuantity = quantity.to(baseUnit)
+
+		then:
+		QuantityUtil.equals(expectedQuantity, actualQuantity, testingTolerance)
+
+		where:
+		quantity                                               | baseUnit            || expectedQuantity
+		Quantities.getQuantity(1d, EURO_PER_KILOWATTHOUR)      | EURO_PER_WATTHOUR   || Quantities.getQuantity(1E-3, EURO_PER_WATTHOUR)
+		Quantities.getQuantity(1d, EURO_PER_MEGAWATTHOUR)      | EURO_PER_WATTHOUR   || Quantities.getQuantity(1E-6, EURO_PER_WATTHOUR)
+		Quantities.getQuantity(1d, DEGREE_GEOM)                | RADIAN              || Quantities.getQuantity(0.017453292, RADIAN)
+		Quantities.getQuantity(1d, WATTHOUR)                   | JOULE               || Quantities.getQuantity(3600d, JOULE)
+		Quantities.getQuantity(1d, VARHOUR)                    | JOULE               || Quantities.getQuantity(3600d, JOULE)
+		Quantities.getQuantity(1d, KILOWATTHOUR_PER_KILOMETRE) | WATTHOUR_PER_METRE  || Quantities.getQuantity(1d, WATTHOUR_PER_METRE)
+		Quantities.getQuantity(1d, PU_PER_HOUR)                | PERCENT_PER_HOUR    || Quantities.getQuantity(100d, PERCENT_PER_HOUR)
+		Quantities.getQuantity(1d, FARAD_PER_KILOMETRE)        | FARAD_PER_METRE     || Quantities.getQuantity(1E-3, FARAD_PER_METRE)
+		Quantities.getQuantity(1d, MICROFARAD_PER_KILOMETRE)   | FARAD_PER_KILOMETRE || Quantities.getQuantity(1E-6, FARAD_PER_KILOMETRE)
+		Quantities.getQuantity(1d, MICROFARAD_PER_KILOMETRE)   | FARAD_PER_METRE     || Quantities.getQuantity(1E-9, FARAD_PER_METRE)
+	}
+
 	def "Angle quantities are transferred from degrees to radians correctly"() {
 		given:
-		def degreeQuantity = Quantities.getQuantity(degree, PowerSystemUnits.DEGREE_GEOM)
+		def degreeQuantity = Quantities.getQuantity(degree, DEGREE_GEOM)
 
 		when:
-		def actualValue = degreeQuantity.to(Units.RADIAN).value.doubleValue()
+		def actualValue = degreeQuantity.to(RADIAN).value.doubleValue()
 
 		then:
 		Math.abs(actualValue - radians) < 1E-12
@@ -30,10 +58,10 @@ class PowerSystemUnitsTest extends Specification {
 
 	def "Angle quantities are transferred from radians to radians degree"() {
 		given:
-		def radianQuantity = Quantities.getQuantity(radians, Units.RADIAN)
+		def radianQuantity = Quantities.getQuantity(radians, RADIAN)
 
 		when:
-		def actualValue = radianQuantity.to(PowerSystemUnits.DEGREE_GEOM).value.doubleValue()
+		def actualValue = radianQuantity.to(DEGREE_GEOM).value.doubleValue()
 
 		then:
 		Math.abs(actualValue - degree) < 1E-12