refactor: rename layers

This commit is contained in:
Ilkka Seppälä
2024-05-26 11:13:13 +03:00
parent 88101fc4eb
commit e12085f158
29 changed files with 2 additions and 2 deletions
@@ -0,0 +1,49 @@
/*
* This project is licensed under the MIT license. Module model-view-viewmodel is using ZK framework licensed under LGPL (see lgpl-3.0.txt).
*
* The MIT License
* Copyright © 2014-2022 Ilkka Seppälä
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
package com.iluwatar.layers.app;
import static org.junit.jupiter.api.Assertions.assertNotNull;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.context.ApplicationContext;
@SpringBootTest(classes = LayersApp.class)
class LayersAppTests {
private final ApplicationContext applicationContext;
@Autowired
LayersAppTests(ApplicationContext applicationContext) {
this.applicationContext = applicationContext;
}
@Test
void contextLoads() {
assertNotNull(applicationContext);
}
}
@@ -0,0 +1,121 @@
/*
* This project is licensed under the MIT license. Module model-view-viewmodel is using ZK framework licensed under LGPL (see lgpl-3.0.txt).
*
* The MIT License
* Copyright © 2014-2022 Ilkka Seppälä
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
package com.iluwatar.layers.entity;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertNotNull;
import static org.junit.jupiter.api.Assertions.assertNull;
import static org.junit.jupiter.api.Assertions.assertTrue;
import entity.Cake;
import entity.CakeLayer;
import entity.CakeTopping;
import java.util.HashSet;
import java.util.Set;
import org.junit.jupiter.api.Test;
/**
* This class contains unit tests for the Cake class.
* It tests the functionality of setting and getting the id, topping, and layers of a Cake object.
* It also tests the functionality of adding a layer to a Cake object and converting a Cake object to a string.
*/
class CakeTest {
@Test
void testSetId() {
final var cake = new Cake();
assertNull(cake.getId());
final var expectedId = 1234L;
cake.setId(expectedId);
assertEquals(expectedId, cake.getId());
}
@Test
void testSetTopping() {
final var cake = new Cake();
assertNull(cake.getTopping());
final var expectedTopping = new CakeTopping("DummyTopping", 1000);
cake.setTopping(expectedTopping);
assertEquals(expectedTopping, cake.getTopping());
}
@Test
void testSetLayers() {
final var cake = new Cake();
assertNotNull(cake.getLayers());
assertTrue(cake.getLayers().isEmpty());
final var expectedLayers = Set.of(new CakeLayer("layer1", 1000), new CakeLayer("layer2", 2000),
new CakeLayer("layer3", 3000));
cake.setLayers(expectedLayers);
assertEquals(expectedLayers, cake.getLayers());
}
@Test
void testAddLayer() {
final var cake = new Cake();
assertNotNull(cake.getLayers());
assertTrue(cake.getLayers().isEmpty());
final Set<CakeLayer> initialLayers = new HashSet<>();
initialLayers.add(new CakeLayer("layer1", 1000));
initialLayers.add(new CakeLayer("layer2", 2000));
cake.setLayers(initialLayers);
assertEquals(initialLayers, cake.getLayers());
final var newLayer = new CakeLayer("layer3", 3000);
cake.addLayer(newLayer);
final Set<CakeLayer> expectedLayers = new HashSet<>();
expectedLayers.addAll(initialLayers);
expectedLayers.addAll(initialLayers);
expectedLayers.add(newLayer);
assertEquals(expectedLayers, cake.getLayers());
}
@Test
void testToString() {
final var topping = new CakeTopping("topping", 20);
topping.setId(2345L);
final var layer = new CakeLayer("layer", 100);
layer.setId(3456L);
final var cake = new Cake();
cake.setId(1234L);
cake.setTopping(topping);
cake.addLayer(layer);
final var expected = "id=1234 topping=id=2345 name=topping calories=20 "
+ "layers=[id=3456 name=layer calories=100]";
assertEquals(expected, cake.toString());
}
}
@@ -0,0 +1,69 @@
/*
* This project is licensed under the MIT license. Module model-view-viewmodel is using ZK framework licensed under LGPL (see lgpl-3.0.txt).
*
* The MIT License
* Copyright © 2014-2022 Ilkka Seppälä
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
package com.iluwatar.layers.exception;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertNull;
import exception.CakeBakingException;
import org.junit.jupiter.api.Test;
/**
* Tests for the {@link CakeBakingException} class.
* This class contains unit tests to verify the correct functionality
* of the {@code CakeBakingException} class constructors, including the default constructor
* and the constructor that accepts a message parameter.
*/
class CakeBakingExceptionTest {
/**
* Tests the default constructor of {@link CakeBakingException}.
* Ensures that an exception created with the default constructor has
* {@code null} as its message and cause.
*/
@Test
void testConstructor() {
final var exception = new CakeBakingException();
assertNull(exception.getMessage(), "The message should be null for the default constructor.");
assertNull(exception.getCause(), "The cause should be null for the default constructor.");
}
/**
* Tests the constructor of {@link CakeBakingException} that accepts a message.
* Ensures that an exception created with this constructor correctly stores the provided message
* and has {@code null} as its cause.
*/
@Test
void testConstructorWithMessage() {
final var expectedMessage = "message";
final var exception = new CakeBakingException(expectedMessage);
assertEquals(expectedMessage, exception.getMessage(),
"The stored message should match the expected message.");
assertNull(exception.getCause(),
"The cause should be null when an exception is created with only a message.");
}
}
@@ -0,0 +1,197 @@
/*
* This project is licensed under the MIT license. Module model-view-viewmodel is using ZK framework licensed under LGPL (see lgpl-3.0.txt).
*
* The MIT License
* Copyright © 2014-2022 Ilkka Seppälä
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
package com.iluwatar.layers.service;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertFalse;
import static org.junit.jupiter.api.Assertions.assertNotNull;
import static org.junit.jupiter.api.Assertions.assertThrows;
import static org.junit.jupiter.api.Assertions.assertTrue;
import com.iluwatar.layers.app.LayersApp;
import dto.CakeInfo;
import dto.CakeLayerInfo;
import dto.CakeToppingInfo;
import exception.CakeBakingException;
import java.util.Collections;
import java.util.List;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import service.CakeBakingServiceImpl;
/**
* Constructs a new instance of CakeBakingServiceImplTest.
*
*/
@SpringBootTest(classes = LayersApp.class)
class CakeBakingServiceImplTest {
private final CakeBakingServiceImpl cakeBakingService;
@Autowired
CakeBakingServiceImplTest(CakeBakingServiceImpl cakeBakingService) {
this.cakeBakingService = cakeBakingService;
}
@BeforeEach
void setUp() {
cakeBakingService.deleteAllCakes();
cakeBakingService.deleteAllLayers();
cakeBakingService.deleteAllToppings();
}
@Test
void testLayers() {
final var initialLayers = cakeBakingService.getAvailableLayers();
assertNotNull(initialLayers);
assertTrue(initialLayers.isEmpty());
cakeBakingService.saveNewLayer(new CakeLayerInfo("Layer1", 1000));
cakeBakingService.saveNewLayer(new CakeLayerInfo("Layer2", 2000));
final var availableLayers = cakeBakingService.getAvailableLayers();
assertNotNull(availableLayers);
assertEquals(2, availableLayers.size());
for (final var layer : availableLayers) {
assertNotNull(layer.id);
assertNotNull(layer.name);
assertNotNull(layer.toString());
assertTrue(layer.calories > 0);
}
}
@Test
void testToppings() {
final var initialToppings = cakeBakingService.getAvailableToppings();
assertNotNull(initialToppings);
assertTrue(initialToppings.isEmpty());
cakeBakingService.saveNewTopping(new CakeToppingInfo("Topping1", 1000));
cakeBakingService.saveNewTopping(new CakeToppingInfo("Topping2", 2000));
final var availableToppings = cakeBakingService.getAvailableToppings();
assertNotNull(availableToppings);
assertEquals(2, availableToppings.size());
for (final var topping : availableToppings) {
assertNotNull(topping.id);
assertNotNull(topping.name);
assertNotNull(topping.toString());
assertTrue(topping.calories > 0);
}
}
@Test
void testBakeCakes() throws CakeBakingException {
final var initialCakes = cakeBakingService.getAllCakes();
assertNotNull(initialCakes);
assertTrue(initialCakes.isEmpty());
final var topping1 = new CakeToppingInfo("Topping1", 1000);
final var topping2 = new CakeToppingInfo("Topping2", 2000);
cakeBakingService.saveNewTopping(topping1);
cakeBakingService.saveNewTopping(topping2);
final var layer1 = new CakeLayerInfo("Layer1", 1000);
final var layer2 = new CakeLayerInfo("Layer2", 2000);
final var layer3 = new CakeLayerInfo("Layer3", 2000);
cakeBakingService.saveNewLayer(layer1);
cakeBakingService.saveNewLayer(layer2);
cakeBakingService.saveNewLayer(layer3);
cakeBakingService.bakeNewCake(new CakeInfo(topping1, List.of(layer1, layer2)));
cakeBakingService.bakeNewCake(new CakeInfo(topping2, Collections.singletonList(layer3)));
final var allCakes = cakeBakingService.getAllCakes();
assertNotNull(allCakes);
assertEquals(2, allCakes.size());
for (final var cakeInfo : allCakes) {
assertNotNull(cakeInfo.id);
assertNotNull(cakeInfo.cakeToppingInfo);
assertNotNull(cakeInfo.cakeLayerInfos);
assertNotNull(cakeInfo.toString());
assertFalse(cakeInfo.cakeLayerInfos.isEmpty());
assertTrue(cakeInfo.calculateTotalCalories() > 0);
}
}
@Test
void testBakeCakeMissingTopping() {
final var layer1 = new CakeLayerInfo("Layer1", 1000);
final var layer2 = new CakeLayerInfo("Layer2", 2000);
cakeBakingService.saveNewLayer(layer1);
cakeBakingService.saveNewLayer(layer2);
final var missingTopping = new CakeToppingInfo("Topping1", 1000);
assertThrows(CakeBakingException.class,
() -> cakeBakingService.bakeNewCake(new CakeInfo(missingTopping, List.of(layer1, layer2))));
}
@Test
void testBakeCakeMissingLayer() {
final var initialCakes = cakeBakingService.getAllCakes();
assertNotNull(initialCakes);
assertTrue(initialCakes.isEmpty());
final var topping1 = new CakeToppingInfo("Topping1", 1000);
cakeBakingService.saveNewTopping(topping1);
final var layer1 = new CakeLayerInfo("Layer1", 1000);
cakeBakingService.saveNewLayer(layer1);
final var missingLayer = new CakeLayerInfo("Layer2", 2000);
assertThrows(CakeBakingException.class,
() -> cakeBakingService.bakeNewCake(new CakeInfo(topping1, List.of(layer1, missingLayer))));
}
@Test
void testBakeCakesUsedLayer() throws CakeBakingException {
final var initialCakes = cakeBakingService.getAllCakes();
assertNotNull(initialCakes);
assertTrue(initialCakes.isEmpty());
final var topping1 = new CakeToppingInfo("Topping1", 1000);
final var topping2 = new CakeToppingInfo("Topping2", 2000);
cakeBakingService.saveNewTopping(topping1);
cakeBakingService.saveNewTopping(topping2);
final var layer1 = new CakeLayerInfo("Layer1", 1000);
final var layer2 = new CakeLayerInfo("Layer2", 2000);
cakeBakingService.saveNewLayer(layer1);
cakeBakingService.saveNewLayer(layer2);
cakeBakingService.bakeNewCake(new CakeInfo(topping1, List.of(layer1, layer2)));
assertThrows(CakeBakingException.class, () -> cakeBakingService.bakeNewCake(
new CakeInfo(topping2, Collections.singletonList(layer2))));
}
}
@@ -0,0 +1,113 @@
/*
* This project is licensed under the MIT license. Module model-view-viewmodel is using ZK framework licensed under LGPL (see lgpl-3.0.txt).
*
* The MIT License
* Copyright © 2014-2022 Ilkka Seppälä
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
package com.iluwatar.layers.view;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.when;
import ch.qos.logback.classic.Logger;
import ch.qos.logback.classic.spi.ILoggingEvent;
import ch.qos.logback.core.AppenderBase;
import dto.CakeInfo;
import dto.CakeLayerInfo;
import dto.CakeToppingInfo;
import java.util.LinkedList;
import java.util.List;
import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.slf4j.LoggerFactory;
import service.CakeBakingService;
import view.CakeViewImpl;
/**
* This class contains unit tests for the CakeViewImpl class.
* It tests the functionality of rendering cakes using the CakeViewImpl class.
* It also tests the logging functionality of the CakeViewImpl class.
*/
class CakeViewImplTest {
private InMemoryAppender appender;
@BeforeEach
void setUp() {
appender = new InMemoryAppender(CakeViewImpl.class);
}
@AfterEach
void tearDown() {
appender.stop();
}
/**
* Verify if the cake view renders the expected result.
*/
@Test
void testRender() {
final var layers = List.of(new CakeLayerInfo("layer1", 1000), new CakeLayerInfo("layer2", 2000),
new CakeLayerInfo("layer3", 3000));
final var cake = new CakeInfo(new CakeToppingInfo("topping", 1000), layers);
final var cakes = List.of(cake);
final var bakingService = mock(CakeBakingService.class);
when(bakingService.getAllCakes()).thenReturn(cakes);
final var cakeView = new CakeViewImpl(bakingService);
assertEquals(0, appender.getLogSize());
cakeView.render();
assertEquals(cake.toString(), appender.getLastMessage());
}
private static class InMemoryAppender extends AppenderBase<ILoggingEvent> {
private final List<ILoggingEvent> log = new LinkedList<>();
public InMemoryAppender(Class clazz) {
((Logger) LoggerFactory.getLogger(clazz)).addAppender(this);
start();
}
@Override
protected void append(ILoggingEvent eventObject) {
log.add(eventObject);
}
public String getLastMessage() {
return log.get(log.size() - 1).getFormattedMessage();
}
public int getLogSize() {
return log.size();
}
}
}