Skip to content

Commit 778d9cb

Browse files
committed
Add maven wrapper and tests
1 parent b9d6ccb commit 778d9cb

File tree

8 files changed

+866
-56
lines changed

8 files changed

+866
-56
lines changed
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
wrapperVersion=3.3.4
2+
distributionType=only-script
3+
distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.9.11/apache-maven-3.9.11-bin.zip

README.md

Lines changed: 76 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,77 @@
1-
# 🚀 Requirements
1+
# Warehouse Kata – Instructions
22

3-
Add requirements here
3+
Welcome! In this exercise you will implement a small domain around a Warehouse with products. Your goal is to:
4+
- Create and complete several classes/interfaces under src/main/java that are currently missing or partially implemented.
5+
- Pick correct data types for parameters and return values so the project compiles and tests can run.
6+
- Make all tests in BasicTest green first.
7+
- Commit after major steps. When all BasicTest tests are green, push your commits.
8+
- Extra credit: implement the advanced features so that EdgeCaseTest is also green.
9+
10+
## 1) Getting started
11+
1. Open this project in your IDE (IntelliJ IDEA recommended).
12+
2. Ensure you have JDK 25.
13+
3. Build once to see current state:
14+
- ./mvnw compile
15+
16+
## 2) What you will need to create/finish
17+
You will work primarily in src/main/java/com/example. Some files already exist but contain TODOs or empty methods. Implement the following:
18+
19+
- Category (value object)
20+
- Use a private constructor and a public static factory Category.of(String name).
21+
- Validate input: null => "Category name can't be null"; empty/blank => "Category name can't be blank".
22+
- Normalize name with initial capital letter (e.g., "fruit" -> "Fruit").
23+
- Cache/flyweight: return the same instance for the same normalized name.
24+
25+
- Product (abstract base class)
26+
- Keep UUID id, String name, Category category, BigDecimal price.
27+
- Provide getters named uuid(), name(), category(), price() and a setter price(BigDecimal).
28+
- Provide an abstract String productDetails() for polymorphism.
29+
30+
- FoodProduct (extends Product)
31+
- Implements Perishable and Shippable.
32+
- Fields: LocalDate expirationDate, BigDecimal weight (kg).
33+
- Validations: negative price -> IllegalArgumentException("Price cannot be negative."); negative weight -> IllegalArgumentException("Weight cannot be negative.").
34+
- productDetails() should look like: "Food: Milk, Expires: 2025-12-24".
35+
- Shipping rule: cost = weight * 50.
36+
37+
- ElectronicsProduct (extends Product)
38+
- Implements Shippable.
39+
- Fields: int warrantyMonths, BigDecimal weight (kg).
40+
- Validation: negative warranty -> IllegalArgumentException("Warranty months cannot be negative.").
41+
- productDetails() should look like: "Electronics: Laptop, Warranty: 24 months".
42+
- Shipping rule: base 79, add 49 if weight > 5.0 kg.
43+
44+
- Interfaces
45+
- Perishable: expose expirationDate() and a default isExpired() based on LocalDate.now().
46+
- Shippable: expose calculateShippingCost() and weight() (used by shipping optimizer in extra tests).
47+
48+
- Warehouse (singleton per name)
49+
- getInstance(String name) returns the same instance per unique name.
50+
- addProduct(Product): throw IllegalArgumentException("Product cannot be null.") if null.
51+
- getProducts(): return an unmodifiable copy.
52+
- getProductById(UUID): return Optional.
53+
- updateProductPrice(UUID, BigDecimal): when not found, throw NoSuchElementException("Product not found with id: <uuid>"). Also track changed products in getChangedProducts().
54+
- expiredProducts(): return List<Perishable> that are expired.
55+
- shippableProducts(): return List<Shippable> from stored products.
56+
- remove(UUID): remove the matching product if present.
57+
58+
- WarehouseAnalyzer (extra credit)
59+
- Implement the advanced methods used by EdgeCaseTest: price-range search (inclusive), expiring-within-days, case-insensitive name search, above-price search, weighted average per category (round to 2 decimals), price outliers (population stddev), shipping group optimization (first‑fit decreasing by weight), expiration-based discounts, inventory validation summary, and inventory statistics.
60+
61+
## 3) Workflow to follow
62+
1. Implement the missing classes/interfaces and methods so the project compiles.
63+
2. Run tests:
64+
- Basic first: ./mvnw -Dtest=BasicTest test
65+
- When green, commit with a clear message.
66+
3. Extra credit: make EdgeCaseTest green:
67+
- ./mvnw -Dtest=EdgeCaseTest test
68+
4. Commit after each major milestone (e.g., "Implement Product & FoodProduct", "Warehouse behaviors", "Analyzer advanced features").
69+
5. Push when BasicTest is fully green (and EdgeCaseTest too if you do the extra credit).
70+
71+
## 4) Tips
72+
- Prefer BigDecimal for prices and weights (exact values in tests). Where an interface requires Double (e.g., weight()), convert BigDecimal to double on return.
73+
- Always round monetary results to 2 decimals using HALF_UP when tests assert exact values.
74+
- Keep public APIs exactly as tests expect (method names, exception messages).
75+
- Ensure Warehouse.clearProducts() is called in tests; do not share state between tests.
76+
77+
Good luck and have fun!

mvnw

Lines changed: 295 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,295 @@
1+
#!/bin/sh
2+
# ----------------------------------------------------------------------------
3+
# Licensed to the Apache Software Foundation (ASF) under one
4+
# or more contributor license agreements. See the NOTICE file
5+
# distributed with this work for additional information
6+
# regarding copyright ownership. The ASF licenses this file
7+
# to you under the Apache License, Version 2.0 (the
8+
# "License"); you may not use this file except in compliance
9+
# with the License. You may obtain a copy of the License at
10+
#
11+
# http://www.apache.org/licenses/LICENSE-2.0
12+
#
13+
# Unless required by applicable law or agreed to in writing,
14+
# software distributed under the License is distributed on an
15+
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16+
# KIND, either express or implied. See the License for the
17+
# specific language governing permissions and limitations
18+
# under the License.
19+
# ----------------------------------------------------------------------------
20+
21+
# ----------------------------------------------------------------------------
22+
# Apache Maven Wrapper startup batch script, version 3.3.4
23+
#
24+
# Optional ENV vars
25+
# -----------------
26+
# JAVA_HOME - location of a JDK home dir, required when download maven via java source
27+
# MVNW_REPOURL - repo url base for downloading maven distribution
28+
# MVNW_USERNAME/MVNW_PASSWORD - user and password for downloading maven
29+
# MVNW_VERBOSE - true: enable verbose log; debug: trace the mvnw script; others: silence the output
30+
# ----------------------------------------------------------------------------
31+
32+
set -euf
33+
[ "${MVNW_VERBOSE-}" != debug ] || set -x
34+
35+
# OS specific support.
36+
native_path() { printf %s\\n "$1"; }
37+
case "$(uname)" in
38+
CYGWIN* | MINGW*)
39+
[ -z "${JAVA_HOME-}" ] || JAVA_HOME="$(cygpath --unix "$JAVA_HOME")"
40+
native_path() { cygpath --path --windows "$1"; }
41+
;;
42+
esac
43+
44+
# set JAVACMD and JAVACCMD
45+
set_java_home() {
46+
# For Cygwin and MinGW, ensure paths are in Unix format before anything is touched
47+
if [ -n "${JAVA_HOME-}" ]; then
48+
if [ -x "$JAVA_HOME/jre/sh/java" ]; then
49+
# IBM's JDK on AIX uses strange locations for the executables
50+
JAVACMD="$JAVA_HOME/jre/sh/java"
51+
JAVACCMD="$JAVA_HOME/jre/sh/javac"
52+
else
53+
JAVACMD="$JAVA_HOME/bin/java"
54+
JAVACCMD="$JAVA_HOME/bin/javac"
55+
56+
if [ ! -x "$JAVACMD" ] || [ ! -x "$JAVACCMD" ]; then
57+
echo "The JAVA_HOME environment variable is not defined correctly, so mvnw cannot run." >&2
58+
echo "JAVA_HOME is set to \"$JAVA_HOME\", but \"\$JAVA_HOME/bin/java\" or \"\$JAVA_HOME/bin/javac\" does not exist." >&2
59+
return 1
60+
fi
61+
fi
62+
else
63+
JAVACMD="$(
64+
'set' +e
65+
'unset' -f command 2>/dev/null
66+
'command' -v java
67+
)" || :
68+
JAVACCMD="$(
69+
'set' +e
70+
'unset' -f command 2>/dev/null
71+
'command' -v javac
72+
)" || :
73+
74+
if [ ! -x "${JAVACMD-}" ] || [ ! -x "${JAVACCMD-}" ]; then
75+
echo "The java/javac command does not exist in PATH nor is JAVA_HOME set, so mvnw cannot run." >&2
76+
return 1
77+
fi
78+
fi
79+
}
80+
81+
# hash string like Java String::hashCode
82+
hash_string() {
83+
str="${1:-}" h=0
84+
while [ -n "$str" ]; do
85+
char="${str%"${str#?}"}"
86+
h=$(((h * 31 + $(LC_CTYPE=C printf %d "'$char")) % 4294967296))
87+
str="${str#?}"
88+
done
89+
printf %x\\n $h
90+
}
91+
92+
verbose() { :; }
93+
[ "${MVNW_VERBOSE-}" != true ] || verbose() { printf %s\\n "${1-}"; }
94+
95+
die() {
96+
printf %s\\n "$1" >&2
97+
exit 1
98+
}
99+
100+
trim() {
101+
# MWRAPPER-139:
102+
# Trims trailing and leading whitespace, carriage returns, tabs, and linefeeds.
103+
# Needed for removing poorly interpreted newline sequences when running in more
104+
# exotic environments such as mingw bash on Windows.
105+
printf "%s" "${1}" | tr -d '[:space:]'
106+
}
107+
108+
scriptDir="$(dirname "$0")"
109+
scriptName="$(basename "$0")"
110+
111+
# parse distributionUrl and optional distributionSha256Sum, requires .mvn/wrapper/maven-wrapper.properties
112+
while IFS="=" read -r key value; do
113+
case "${key-}" in
114+
distributionUrl) distributionUrl=$(trim "${value-}") ;;
115+
distributionSha256Sum) distributionSha256Sum=$(trim "${value-}") ;;
116+
esac
117+
done <"$scriptDir/.mvn/wrapper/maven-wrapper.properties"
118+
[ -n "${distributionUrl-}" ] || die "cannot read distributionUrl property in $scriptDir/.mvn/wrapper/maven-wrapper.properties"
119+
120+
case "${distributionUrl##*/}" in
121+
maven-mvnd-*bin.*)
122+
MVN_CMD=mvnd.sh _MVNW_REPO_PATTERN=/maven/mvnd/
123+
case "${PROCESSOR_ARCHITECTURE-}${PROCESSOR_ARCHITEW6432-}:$(uname -a)" in
124+
*AMD64:CYGWIN* | *AMD64:MINGW*) distributionPlatform=windows-amd64 ;;
125+
:Darwin*x86_64) distributionPlatform=darwin-amd64 ;;
126+
:Darwin*arm64) distributionPlatform=darwin-aarch64 ;;
127+
:Linux*x86_64*) distributionPlatform=linux-amd64 ;;
128+
*)
129+
echo "Cannot detect native platform for mvnd on $(uname)-$(uname -m), use pure java version" >&2
130+
distributionPlatform=linux-amd64
131+
;;
132+
esac
133+
distributionUrl="${distributionUrl%-bin.*}-$distributionPlatform.zip"
134+
;;
135+
maven-mvnd-*) MVN_CMD=mvnd.sh _MVNW_REPO_PATTERN=/maven/mvnd/ ;;
136+
*) MVN_CMD="mvn${scriptName#mvnw}" _MVNW_REPO_PATTERN=/org/apache/maven/ ;;
137+
esac
138+
139+
# apply MVNW_REPOURL and calculate MAVEN_HOME
140+
# maven home pattern: ~/.m2/wrapper/dists/{apache-maven-<version>,maven-mvnd-<version>-<platform>}/<hash>
141+
[ -z "${MVNW_REPOURL-}" ] || distributionUrl="$MVNW_REPOURL$_MVNW_REPO_PATTERN${distributionUrl#*"$_MVNW_REPO_PATTERN"}"
142+
distributionUrlName="${distributionUrl##*/}"
143+
distributionUrlNameMain="${distributionUrlName%.*}"
144+
distributionUrlNameMain="${distributionUrlNameMain%-bin}"
145+
MAVEN_USER_HOME="${MAVEN_USER_HOME:-${HOME}/.m2}"
146+
MAVEN_HOME="${MAVEN_USER_HOME}/wrapper/dists/${distributionUrlNameMain-}/$(hash_string "$distributionUrl")"
147+
148+
exec_maven() {
149+
unset MVNW_VERBOSE MVNW_USERNAME MVNW_PASSWORD MVNW_REPOURL || :
150+
exec "$MAVEN_HOME/bin/$MVN_CMD" "$@" || die "cannot exec $MAVEN_HOME/bin/$MVN_CMD"
151+
}
152+
153+
if [ -d "$MAVEN_HOME" ]; then
154+
verbose "found existing MAVEN_HOME at $MAVEN_HOME"
155+
exec_maven "$@"
156+
fi
157+
158+
case "${distributionUrl-}" in
159+
*?-bin.zip | *?maven-mvnd-?*-?*.zip) ;;
160+
*) die "distributionUrl is not valid, must match *-bin.zip or maven-mvnd-*.zip, but found '${distributionUrl-}'" ;;
161+
esac
162+
163+
# prepare tmp dir
164+
if TMP_DOWNLOAD_DIR="$(mktemp -d)" && [ -d "$TMP_DOWNLOAD_DIR" ]; then
165+
clean() { rm -rf -- "$TMP_DOWNLOAD_DIR"; }
166+
trap clean HUP INT TERM EXIT
167+
else
168+
die "cannot create temp dir"
169+
fi
170+
171+
mkdir -p -- "${MAVEN_HOME%/*}"
172+
173+
# Download and Install Apache Maven
174+
verbose "Couldn't find MAVEN_HOME, downloading and installing it ..."
175+
verbose "Downloading from: $distributionUrl"
176+
verbose "Downloading to: $TMP_DOWNLOAD_DIR/$distributionUrlName"
177+
178+
# select .zip or .tar.gz
179+
if ! command -v unzip >/dev/null; then
180+
distributionUrl="${distributionUrl%.zip}.tar.gz"
181+
distributionUrlName="${distributionUrl##*/}"
182+
fi
183+
184+
# verbose opt
185+
__MVNW_QUIET_WGET=--quiet __MVNW_QUIET_CURL=--silent __MVNW_QUIET_UNZIP=-q __MVNW_QUIET_TAR=''
186+
[ "${MVNW_VERBOSE-}" != true ] || __MVNW_QUIET_WGET='' __MVNW_QUIET_CURL='' __MVNW_QUIET_UNZIP='' __MVNW_QUIET_TAR=v
187+
188+
# normalize http auth
189+
case "${MVNW_PASSWORD:+has-password}" in
190+
'') MVNW_USERNAME='' MVNW_PASSWORD='' ;;
191+
has-password) [ -n "${MVNW_USERNAME-}" ] || MVNW_USERNAME='' MVNW_PASSWORD='' ;;
192+
esac
193+
194+
if [ -z "${MVNW_USERNAME-}" ] && command -v wget >/dev/null; then
195+
verbose "Found wget ... using wget"
196+
wget ${__MVNW_QUIET_WGET:+"$__MVNW_QUIET_WGET"} "$distributionUrl" -O "$TMP_DOWNLOAD_DIR/$distributionUrlName" || die "wget: Failed to fetch $distributionUrl"
197+
elif [ -z "${MVNW_USERNAME-}" ] && command -v curl >/dev/null; then
198+
verbose "Found curl ... using curl"
199+
curl ${__MVNW_QUIET_CURL:+"$__MVNW_QUIET_CURL"} -f -L -o "$TMP_DOWNLOAD_DIR/$distributionUrlName" "$distributionUrl" || die "curl: Failed to fetch $distributionUrl"
200+
elif set_java_home; then
201+
verbose "Falling back to use Java to download"
202+
javaSource="$TMP_DOWNLOAD_DIR/Downloader.java"
203+
targetZip="$TMP_DOWNLOAD_DIR/$distributionUrlName"
204+
cat >"$javaSource" <<-END
205+
public class Downloader extends java.net.Authenticator
206+
{
207+
protected java.net.PasswordAuthentication getPasswordAuthentication()
208+
{
209+
return new java.net.PasswordAuthentication( System.getenv( "MVNW_USERNAME" ), System.getenv( "MVNW_PASSWORD" ).toCharArray() );
210+
}
211+
public static void main( String[] args ) throws Exception
212+
{
213+
setDefault( new Downloader() );
214+
java.nio.file.Files.copy( java.net.URI.create( args[0] ).toURL().openStream(), java.nio.file.Paths.get( args[1] ).toAbsolutePath().normalize() );
215+
}
216+
}
217+
END
218+
# For Cygwin/MinGW, switch paths to Windows format before running javac and java
219+
verbose " - Compiling Downloader.java ..."
220+
"$(native_path "$JAVACCMD")" "$(native_path "$javaSource")" || die "Failed to compile Downloader.java"
221+
verbose " - Running Downloader.java ..."
222+
"$(native_path "$JAVACMD")" -cp "$(native_path "$TMP_DOWNLOAD_DIR")" Downloader "$distributionUrl" "$(native_path "$targetZip")"
223+
fi
224+
225+
# If specified, validate the SHA-256 sum of the Maven distribution zip file
226+
if [ -n "${distributionSha256Sum-}" ]; then
227+
distributionSha256Result=false
228+
if [ "$MVN_CMD" = mvnd.sh ]; then
229+
echo "Checksum validation is not supported for maven-mvnd." >&2
230+
echo "Please disable validation by removing 'distributionSha256Sum' from your maven-wrapper.properties." >&2
231+
exit 1
232+
elif command -v sha256sum >/dev/null; then
233+
if echo "$distributionSha256Sum $TMP_DOWNLOAD_DIR/$distributionUrlName" | sha256sum -c - >/dev/null 2>&1; then
234+
distributionSha256Result=true
235+
fi
236+
elif command -v shasum >/dev/null; then
237+
if echo "$distributionSha256Sum $TMP_DOWNLOAD_DIR/$distributionUrlName" | shasum -a 256 -c >/dev/null 2>&1; then
238+
distributionSha256Result=true
239+
fi
240+
else
241+
echo "Checksum validation was requested but neither 'sha256sum' or 'shasum' are available." >&2
242+
echo "Please install either command, or disable validation by removing 'distributionSha256Sum' from your maven-wrapper.properties." >&2
243+
exit 1
244+
fi
245+
if [ $distributionSha256Result = false ]; then
246+
echo "Error: Failed to validate Maven distribution SHA-256, your Maven distribution might be compromised." >&2
247+
echo "If you updated your Maven version, you need to update the specified distributionSha256Sum property." >&2
248+
exit 1
249+
fi
250+
fi
251+
252+
# unzip and move
253+
if command -v unzip >/dev/null; then
254+
unzip ${__MVNW_QUIET_UNZIP:+"$__MVNW_QUIET_UNZIP"} "$TMP_DOWNLOAD_DIR/$distributionUrlName" -d "$TMP_DOWNLOAD_DIR" || die "failed to unzip"
255+
else
256+
tar xzf${__MVNW_QUIET_TAR:+"$__MVNW_QUIET_TAR"} "$TMP_DOWNLOAD_DIR/$distributionUrlName" -C "$TMP_DOWNLOAD_DIR" || die "failed to untar"
257+
fi
258+
259+
# Find the actual extracted directory name (handles snapshots where filename != directory name)
260+
actualDistributionDir=""
261+
262+
# First try the expected directory name (for regular distributions)
263+
if [ -d "$TMP_DOWNLOAD_DIR/$distributionUrlNameMain" ]; then
264+
if [ -f "$TMP_DOWNLOAD_DIR/$distributionUrlNameMain/bin/$MVN_CMD" ]; then
265+
actualDistributionDir="$distributionUrlNameMain"
266+
fi
267+
fi
268+
269+
# If not found, search for any directory with the Maven executable (for snapshots)
270+
if [ -z "$actualDistributionDir" ]; then
271+
# enable globbing to iterate over items
272+
set +f
273+
for dir in "$TMP_DOWNLOAD_DIR"/*; do
274+
if [ -d "$dir" ]; then
275+
if [ -f "$dir/bin/$MVN_CMD" ]; then
276+
actualDistributionDir="$(basename "$dir")"
277+
break
278+
fi
279+
fi
280+
done
281+
set -f
282+
fi
283+
284+
if [ -z "$actualDistributionDir" ]; then
285+
verbose "Contents of $TMP_DOWNLOAD_DIR:"
286+
verbose "$(ls -la "$TMP_DOWNLOAD_DIR")"
287+
die "Could not find Maven distribution directory in extracted archive"
288+
fi
289+
290+
verbose "Found extracted Maven distribution directory: $actualDistributionDir"
291+
printf %s\\n "$distributionUrl" >"$TMP_DOWNLOAD_DIR/$actualDistributionDir/mvnw.url"
292+
mv -- "$TMP_DOWNLOAD_DIR/$actualDistributionDir" "$MAVEN_HOME" || [ -d "$MAVEN_HOME" ] || die "fail to move MAVEN_HOME"
293+
294+
clean || :
295+
exec_maven "$@"

0 commit comments

Comments
 (0)