diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 00000000..760b7795 --- /dev/null +++ b/.editorconfig @@ -0,0 +1,15 @@ +root = true + +[*] +charset = utf-8 +end_of_line = lf +indent_style = space +indent_size = 4 +insert_final_newline = true +trim_trailing_whitespace = true + +[*.yml] +indent_size = 2 + +[*.yaml] +indent_size = 2 \ No newline at end of file diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 00000000..5d70067f --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,27 @@ +name: CI Pipeline +on: + push: + branches: + - main + + pull_request: + +jobs: + build: + runs-on: ubuntu-latest + steps: + - name: Checkout code + uses: actions/checkout@v5 + + - name: Setup Java 25 + uses: actions/setup-java@v5.2.0 + with: + distribution: 'temurin' + java-version: '25' + cache: 'maven' + + - name: Run tests + run: ./mvnw -B test + + - name: Run spotless checks + run: ./mvnw -B spotless:check \ No newline at end of file diff --git a/.github/workflows/docker-release.yml b/.github/workflows/docker-release.yml new file mode 100644 index 00000000..8db73760 --- /dev/null +++ b/.github/workflows/docker-release.yml @@ -0,0 +1,47 @@ +name: Publish Docker Image +on: + release: + types: + - created + +jobs: + publish: + runs-on: ubuntu-latest + permissions: + contents: read + packages: write + + steps: + - name: Checkout repo + uses: actions/checkout@v6.0.2 + + - name: Setup QEMU + uses: docker/setup-qemu-action@v3 + + - name: Setup Docker BuildX + uses: docker/setup-buildx-action@v3 + + - name: Login to GHCR + uses: docker/login-action@v3 + with: + registry: ghcr.io + username: ${{ github.actor }} + password: ${{ secrets.GITHUB_TOKEN }} + + - name: Extract Docker metadata + id: meta + uses: docker/metadata-action@v5 + with: + images: ghcr.io/${{ github.repository_owner }}/project-webserver-juv25d + tags: type=ref,name=short + labels: org.opencontainers.image.source=${{ github.repository }} + + - name: Build and push Docker image + uses: docker/build-push-action@v6 + with: + context: . + push: true + platforms: linux/amd64,linux/arm64 + tags: ${{ steps.meta.outputs.tags }} + labels: ${{ steps.meta.outputs.labels }} + diff --git a/.mvn/wrapper/maven-wrapper.properties b/.mvn/wrapper/maven-wrapper.properties new file mode 100644 index 00000000..d38f8868 --- /dev/null +++ b/.mvn/wrapper/maven-wrapper.properties @@ -0,0 +1,3 @@ +wrapperVersion=3.3.4 +distributionType=only-script +distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.8.7/apache-maven-3.8.7-bin.zip diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 00000000..37ca9fd9 --- /dev/null +++ b/Dockerfile @@ -0,0 +1,17 @@ +FROM maven:3.9-eclipse-temurin-21 AS build + +WORKDIR /app + +COPY pom.xml pom.xml +RUN mvn dependency:go-offline -B + +COPY src ./src +RUN mvn clean package -DskipTests + +FROM eclipse-temurin:21-jre-alpine + +WORKDIR /app + +# might need to update this later when we have our explicit class names +COPY --from=build /app/target/*.jar app.jar +ENTRYPOINT ["java", "-jar", "app.jar"] \ No newline at end of file diff --git a/docs/adr/ADR-001-static-file-serving-architecture.md b/docs/adr/ADR-001-static-file-serving-architecture.md new file mode 100644 index 00000000..6ad14b04 --- /dev/null +++ b/docs/adr/ADR-001-static-file-serving-architecture.md @@ -0,0 +1,249 @@ +# ADR-001: Static File Serving Architecture + +**Date:** 2026-02-11 +**Status:** Proposed +**Deciders:** Team juv25d +**Technical Story:** Issue #18 - GET handling for static files + +--- + +## Context + +Our HTTP server needs the ability to serve static files (HTML, CSS, JavaScript, images, etc.) to support building complete web applications. Currently, our server can parse HTTP requests and send responses, but has no mechanism to serve files from the filesystem. + +### Problem Statement + +We need to implement a static file serving mechanism that: +- Serves files from a designated directory structure +- Maps URLs to filesystem paths safely +- Handles different file types with appropriate Content-Type headers +- Provides reasonable error handling (404, 500, etc.) +- Follows familiar conventions for ease of use + +### Assumptions + +- Static files will be bundled with the application at build time +- Files will be served from the classpath/resources directory +- We're building a development/learning server (not production-grade like Nginx) +- Performance requirements are moderate (not handling thousands of requests/second) + +### Constraints + +- Must work with our existing `HttpParser`, `HttpResponse`, and `HttpResponseWriter` classes +- Should integrate cleanly with the `SocketServer` connection handling +- Must run inside a Docker container with resources directory available +- Team is learning HTTP and web server concepts - architecture should be educational + +--- + +## Decision + +We will implement a **SpringBoot-style static file serving architecture** with the following design: + +### Chosen Solution + +**1. Directory Structure:** +``` +src/main/resources/ +└── static/ + ├── index.html + ├── css/ + │ └── styles.css + ├── js/ + │ └── app.js + └── images/ + └── logo.png +``` + +**2. URL Mapping:** +- Files in `/resources/static/` are served at the root path +- Example: `/resources/static/css/styles.css` → `GET /css/styles.css` +- Root path `/` automatically serves `index.html` if it exists + +**3. Core Components:** + +``` +StaticFileHandler +├── Validates request path (security) +├── Maps URL to resource path +├── Reads file from classpath +├── Determines MIME type +└── Creates HttpResponse with proper headers + +MimeTypeResolver +└── Maps file extensions to Content-Type headers + +Security validator +└── Prevents directory traversal attacks +``` + +**4. Security Measures:** +- Path normalization to prevent `../` attacks +- Whitelist only files within `/static/` directory +- Reject paths containing `..`, absolute paths, or suspicious patterns +- Return 403 Forbidden for security violations + +**5. Error Handling:** +- 404 Not Found: File doesn't exist +- 403 Forbidden: Security violation detected +- 500 Internal Server Error: I/O errors + +**6. MIME Type Handling:** +- Simple extension-based mapping (.html → text/html, .css → text/css, etc.) +- Default to `application/octet-stream` for unknown types +- Support common web file types (HTML, CSS, JS, PNG, JPG, SVG, etc.) + +### Why This Solution? + +1. **Familiar to developers:** SpringBoot convention is widely known and documented +2. **Simple mental model:** Root path maps to `/static/` - easy to understand +3. **Classpath-based:** Works well with JAR packaging and Docker containers +4. **Educational:** Clear separation of concerns teaches good architecture +5. **Extensible:** Easy to add features later (caching, compression, etc.) + +--- + +## Consequences + +### Positive Consequences + +- **Developer Experience:** Developers familiar with SpringBoot will immediately understand the structure +- **Security by Design:** Explicit security validation prevents common vulnerabilities +- **Clean URLs:** No `/static/` prefix in URLs keeps them clean +- **Easy Testing:** Classpath resources are easy to test with JUnit +- **Docker-Friendly:** Resources directory is included in the container image +- **Clear Responsibility:** `StaticFileHandler` has a single, well-defined purpose + +### Negative Consequences / Trade-offs + +- **No Dynamic Content:** This approach only handles static files (but that's the requirement) +- **No Caching:** Every request reads from disk (acceptable for learning project) +- **Limited Performance:** Not optimized for high-traffic scenarios +- **Memory Usage:** Entire files loaded into memory before sending +- **No Range Requests:** Cannot handle partial content requests (HTTP 206) + +### Risks + +- **Large Files:** Loading very large files into memory could cause issues + - *Mitigation:* Document file size limitations, implement streaming later if needed + +- **MIME Type Accuracy:** Simple extension mapping might not always be correct + - *Mitigation:* Cover most common web file types, extend mapping as needed + +- **Classpath Resources:** Files must be in classpath at runtime + - *Mitigation:* Clear documentation about where to place files + +--- + +## Alternatives Considered + +### Alternative 1: Filesystem-based serving (outside classpath) + +**Description:** Serve files from a configurable filesystem directory outside the application. + +**Pros:** +- Files can be updated without rebuilding +- More flexible for deployment +- Easier to handle very large files + +**Cons:** +- More complex configuration +- Path handling is platform-dependent +- Docker volume mounting adds complexity +- Harder to test (need actual filesystem) + +**Why not chosen:** Adds unnecessary complexity for a learning project. Classpath resources are simpler and work well in Docker. + +### Alternative 2: Embedded file map (all files in memory) + +**Description:** Load all static files into a HashMap at startup. + +**Pros:** +- Fastest possible serving (no I/O) +- Very simple lookup logic +- Predictable memory usage + +**Cons:** +- Cannot add files without restart +- High memory usage for many/large files +- Startup time increases +- Not representative of real web servers + +**Why not chosen:** Not scalable and doesn't teach realistic server behavior. Reading from resources is fast enough. + +### Alternative 3: Show /static/ in URLs + +**Description:** Map `/static/file.html` → `/resources/static/file.html` + +**Pros:** +- More explicit about what's being served +- Easier to implement (direct path mapping) +- Clear separation from dynamic routes + +**Cons:** +- Less clean URLs +- Not how SpringBoot or most frameworks work +- Exposing internal structure in URLs + +**Why not chosen:** Doesn't follow common web conventions. Clean URLs are expected behavior. + +--- + +## Implementation Notes + +### Phase 1: Core Implementation +1. Create `StaticFileHandler` class +2. Implement path validation and security checks +3. Create `MimeTypeResolver` utility +4. Integrate with existing `SocketServer` / connection handling +5. Add unit tests for all components + +### Phase 2: Integration +6. Create example static files in `/resources/static/` +7. Update `SocketServer` to use `StaticFileHandler` for GET requests +8. Test with browser +9. Document usage in README + +### Phase 3: Polish +10. Add logging for security violations +11. Create custom 404 error page +12. Add metrics/logging for file serving + +### Example Usage (Future): + +```java +// In connection handler: +if (request.method().equals("GET")) { + HttpResponse response = StaticFileHandler.handleRequest(request); + HttpResponseWriter.write(outputStream, response); +} +``` + +### File Structure After Implementation: + +``` +src/main/resources/static/ +├── index.html (served at GET /) +├── about.html (served at GET /about.html) +├── css/ +│ └── styles.css (served at GET /css/styles.css) +└── js/ + └── app.js (served at GET /js/app.js) +``` + +--- + +## References + +- [Issue #18: GET handling for static files](https://github.com/your-repo/issues/18) +- [SpringBoot Static Content Documentation](https://docs.spring.io/spring-boot/docs/current/reference/html/web.html#web.servlet.spring-mvc.static-content) +- [OWASP Path Traversal](https://owasp.org/www-community/attacks/Path_Traversal) +- [MDN HTTP Content-Type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Type) +- [Common MIME Types](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Common_types) + +--- + +## Related ADRs + +- ADR-002: (Future) Caching Strategy for Static Files +- ADR-003: (Future) Routing Architecture for Dynamic Handlers diff --git a/docs/adr/README.md b/docs/adr/README.md new file mode 100644 index 00000000..4a20561c --- /dev/null +++ b/docs/adr/README.md @@ -0,0 +1,93 @@ +# Architectural Decision Records (ADR) + +This directory contains all Architectural Decision Records for the JavaHttpServer project. + +## What is an ADR? + +An ADR is a document that captures an important architectural decision made along with its context and consequences. This helps the team: + +- Understand why certain design choices were made +- Onboard new team members faster +- Avoid repeating past discussions +- Track the evolution of the system + +## ADR Format + +We use the format described in [Joel Parker Henderson's ADR repository](https://github.com/joelparkerhenderson/architecture-decision-record). + +Each ADR includes: +- **Context:** Why the decision is needed +- **Decision:** What choice was made +- **Consequences:** Trade-offs, pros, and cons + +## Creating a New ADR + +1. Copy `TEMPLATE.md` to a new file named `ADR-XXX-brief-title.md` (e.g., `ADR-001-use-maven-for-build.md`) +2. Fill in all sections of the template +3. Discuss with the team before marking as "Accepted" +4. Commit the ADR to the repository + +## Naming Convention + +- Files are named: `ADR-XXX-descriptive-kebab-case-title.md` +- XXX is a zero-padded sequential number (001, 002, etc.) +- Titles should be brief but descriptive + +## ADR Status + +An ADR can have one of the following statuses: + +- **Proposed:** Under discussion +- **Accepted:** Decision has been made and is active +- **Deprecated:** No longer relevant but kept for historical context +- **Superseded:** Replaced by another ADR (reference the new ADR) + +## Index of ADRs + +| ADR | Title | Status | Date | +|-----|-------|--------|------| +| [001](ADR-001-static-file-serving-architecture.md) | Static File Serving Architecture | Accepted | 2026-02-11 | + +--- + +## Best Practices + +### When to Create an ADR + +Create an ADR when: +- Making a significant architectural choice +- Choosing between multiple viable technical solutions +- Making a decision that will be hard to reverse +- Implementing a pattern that the whole team should follow +- Resolving a technical dispute + +### When NOT to Create an ADR + +Don't create ADRs for: +- Minor code style preferences (use linting/formatting tools) +- Trivial implementation details +- Temporary workarounds +- Decisions that are easily reversible + +### Writing Good ADRs + +**DO:** +- Be specific and concrete +- Include timestamps for time-sensitive information +- Explain the "why" clearly +- Consider alternatives thoroughly +- Keep it focused on one decision + +**DON'T:** +- Change existing ADRs (amend or create new ones instead) +- Make them too long (aim for 1-2 pages) +- Skip the "Consequences" section +- Leave out the context + +--- + +## Resources + +- [ADR GitHub Organization](https://adr.github.io/) +- [Joel Parker Henderson's ADR repo](https://github.com/joelparkerhenderson/architecture-decision-record) +- [Documenting Architecture Decisions by Michael Nygard](https://cognitect.com/blog/2011/11/15/documenting-architecture-decisions) diff --git a/docs/adr/TEMPLATE.md b/docs/adr/TEMPLATE.md new file mode 100644 index 00000000..88447b81 --- /dev/null +++ b/docs/adr/TEMPLATE.md @@ -0,0 +1,80 @@ +# ADR-XXX: [Title of Decision] + +**Date:** YYYY-MM-DD +**Status:** [Proposed | Accepted | Deprecated | Superseded] +**Deciders:** [Names of people involved] +**Technical Story:** [Link to issue/ticket if applicable] + +--- + +## Context + +What is the issue we're seeing that motivates this decision or change? + +### Problem Statement +[Describe the problem clearly] + +### Assumptions +[Any assumptions being made] + +### Constraints +[Technical, time, resource constraints] + +--- + +## Decision + +What is the change that we're proposing and/or doing? + +### Chosen Solution +[Describe the solution] + +### Why This Solution? +[Key reasons for choosing this approach] + +--- + +## Consequences + +What becomes easier or more difficult to do because of this change? + +### Positive Consequences +- [benefit 1] +- [benefit 2] + +### Negative Consequences / Trade-offs +- [drawback 1] +- [drawback 2] + +### Risks +- [risk 1 and mitigation] + +--- + +## Alternatives Considered + +### Alternative 1: [Name] +- **Description:** [Brief description] +- **Pros:** [List advantages] +- **Cons:** [List disadvantages] +- **Why not chosen:** [Reason] + +### Alternative 2: [Name] +- **Description:** [Brief description] +- **Pros:** [List advantages] +- **Cons:** [List disadvantages] +- **Why not chosen:** [Reason] + +--- + +## Implementation Notes + +[Any specific implementation details, migration paths, or action items] + +--- + +## References + +- [Link to documentation] +- [Link to related ADRs] +- [Link to discussion/PR] diff --git a/mvnw b/mvnw new file mode 100755 index 00000000..bd8896bf --- /dev/null +++ b/mvnw @@ -0,0 +1,295 @@ +#!/bin/sh +# ---------------------------------------------------------------------------- +# 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. +# ---------------------------------------------------------------------------- + +# ---------------------------------------------------------------------------- +# Apache Maven Wrapper startup batch script, version 3.3.4 +# +# Optional ENV vars +# ----------------- +# JAVA_HOME - location of a JDK home dir, required when download maven via java source +# MVNW_REPOURL - repo url base for downloading maven distribution +# MVNW_USERNAME/MVNW_PASSWORD - user and password for downloading maven +# MVNW_VERBOSE - true: enable verbose log; debug: trace the mvnw script; others: silence the output +# ---------------------------------------------------------------------------- + +set -euf +[ "${MVNW_VERBOSE-}" != debug ] || set -x + +# OS specific support. +native_path() { printf %s\\n "$1"; } +case "$(uname)" in +CYGWIN* | MINGW*) + [ -z "${JAVA_HOME-}" ] || JAVA_HOME="$(cygpath --unix "$JAVA_HOME")" + native_path() { cygpath --path --windows "$1"; } + ;; +esac + +# set JAVACMD and JAVACCMD +set_java_home() { + # For Cygwin and MinGW, ensure paths are in Unix format before anything is touched + if [ -n "${JAVA_HOME-}" ]; then + if [ -x "$JAVA_HOME/jre/sh/java" ]; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD="$JAVA_HOME/jre/sh/java" + JAVACCMD="$JAVA_HOME/jre/sh/javac" + else + JAVACMD="$JAVA_HOME/bin/java" + JAVACCMD="$JAVA_HOME/bin/javac" + + if [ ! -x "$JAVACMD" ] || [ ! -x "$JAVACCMD" ]; then + echo "The JAVA_HOME environment variable is not defined correctly, so mvnw cannot run." >&2 + echo "JAVA_HOME is set to \"$JAVA_HOME\", but \"\$JAVA_HOME/bin/java\" or \"\$JAVA_HOME/bin/javac\" does not exist." >&2 + return 1 + fi + fi + else + JAVACMD="$( + 'set' +e + 'unset' -f command 2>/dev/null + 'command' -v java + )" || : + JAVACCMD="$( + 'set' +e + 'unset' -f command 2>/dev/null + 'command' -v javac + )" || : + + if [ ! -x "${JAVACMD-}" ] || [ ! -x "${JAVACCMD-}" ]; then + echo "The java/javac command does not exist in PATH nor is JAVA_HOME set, so mvnw cannot run." >&2 + return 1 + fi + fi +} + +# hash string like Java String::hashCode +hash_string() { + str="${1:-}" h=0 + while [ -n "$str" ]; do + char="${str%"${str#?}"}" + h=$(((h * 31 + $(LC_CTYPE=C printf %d "'$char")) % 4294967296)) + str="${str#?}" + done + printf %x\\n $h +} + +verbose() { :; } +[ "${MVNW_VERBOSE-}" != true ] || verbose() { printf %s\\n "${1-}"; } + +die() { + printf %s\\n "$1" >&2 + exit 1 +} + +trim() { + # MWRAPPER-139: + # Trims trailing and leading whitespace, carriage returns, tabs, and linefeeds. + # Needed for removing poorly interpreted newline sequences when running in more + # exotic environments such as mingw bash on Windows. + printf "%s" "${1}" | tr -d '[:space:]' +} + +scriptDir="$(dirname "$0")" +scriptName="$(basename "$0")" + +# parse distributionUrl and optional distributionSha256Sum, requires .mvn/wrapper/maven-wrapper.properties +while IFS="=" read -r key value; do + case "${key-}" in + distributionUrl) distributionUrl=$(trim "${value-}") ;; + distributionSha256Sum) distributionSha256Sum=$(trim "${value-}") ;; + esac +done <"$scriptDir/.mvn/wrapper/maven-wrapper.properties" +[ -n "${distributionUrl-}" ] || die "cannot read distributionUrl property in $scriptDir/.mvn/wrapper/maven-wrapper.properties" + +case "${distributionUrl##*/}" in +maven-mvnd-*bin.*) + MVN_CMD=mvnd.sh _MVNW_REPO_PATTERN=/maven/mvnd/ + case "${PROCESSOR_ARCHITECTURE-}${PROCESSOR_ARCHITEW6432-}:$(uname -a)" in + *AMD64:CYGWIN* | *AMD64:MINGW*) distributionPlatform=windows-amd64 ;; + :Darwin*x86_64) distributionPlatform=darwin-amd64 ;; + :Darwin*arm64) distributionPlatform=darwin-aarch64 ;; + :Linux*x86_64*) distributionPlatform=linux-amd64 ;; + *) + echo "Cannot detect native platform for mvnd on $(uname)-$(uname -m), use pure java version" >&2 + distributionPlatform=linux-amd64 + ;; + esac + distributionUrl="${distributionUrl%-bin.*}-$distributionPlatform.zip" + ;; +maven-mvnd-*) MVN_CMD=mvnd.sh _MVNW_REPO_PATTERN=/maven/mvnd/ ;; +*) MVN_CMD="mvn${scriptName#mvnw}" _MVNW_REPO_PATTERN=/org/apache/maven/ ;; +esac + +# apply MVNW_REPOURL and calculate MAVEN_HOME +# maven home pattern: ~/.m2/wrapper/dists/{apache-maven-,maven-mvnd--}/ +[ -z "${MVNW_REPOURL-}" ] || distributionUrl="$MVNW_REPOURL$_MVNW_REPO_PATTERN${distributionUrl#*"$_MVNW_REPO_PATTERN"}" +distributionUrlName="${distributionUrl##*/}" +distributionUrlNameMain="${distributionUrlName%.*}" +distributionUrlNameMain="${distributionUrlNameMain%-bin}" +MAVEN_USER_HOME="${MAVEN_USER_HOME:-${HOME}/.m2}" +MAVEN_HOME="${MAVEN_USER_HOME}/wrapper/dists/${distributionUrlNameMain-}/$(hash_string "$distributionUrl")" + +exec_maven() { + unset MVNW_VERBOSE MVNW_USERNAME MVNW_PASSWORD MVNW_REPOURL || : + exec "$MAVEN_HOME/bin/$MVN_CMD" "$@" || die "cannot exec $MAVEN_HOME/bin/$MVN_CMD" +} + +if [ -d "$MAVEN_HOME" ]; then + verbose "found existing MAVEN_HOME at $MAVEN_HOME" + exec_maven "$@" +fi + +case "${distributionUrl-}" in +*?-bin.zip | *?maven-mvnd-?*-?*.zip) ;; +*) die "distributionUrl is not valid, must match *-bin.zip or maven-mvnd-*.zip, but found '${distributionUrl-}'" ;; +esac + +# prepare tmp dir +if TMP_DOWNLOAD_DIR="$(mktemp -d)" && [ -d "$TMP_DOWNLOAD_DIR" ]; then + clean() { rm -rf -- "$TMP_DOWNLOAD_DIR"; } + trap clean HUP INT TERM EXIT +else + die "cannot create temp dir" +fi + +mkdir -p -- "${MAVEN_HOME%/*}" + +# Download and Install Apache Maven +verbose "Couldn't find MAVEN_HOME, downloading and installing it ..." +verbose "Downloading from: $distributionUrl" +verbose "Downloading to: $TMP_DOWNLOAD_DIR/$distributionUrlName" + +# select .zip or .tar.gz +if ! command -v unzip >/dev/null; then + distributionUrl="${distributionUrl%.zip}.tar.gz" + distributionUrlName="${distributionUrl##*/}" +fi + +# verbose opt +__MVNW_QUIET_WGET=--quiet __MVNW_QUIET_CURL=--silent __MVNW_QUIET_UNZIP=-q __MVNW_QUIET_TAR='' +[ "${MVNW_VERBOSE-}" != true ] || __MVNW_QUIET_WGET='' __MVNW_QUIET_CURL='' __MVNW_QUIET_UNZIP='' __MVNW_QUIET_TAR=v + +# normalize http auth +case "${MVNW_PASSWORD:+has-password}" in +'') MVNW_USERNAME='' MVNW_PASSWORD='' ;; +has-password) [ -n "${MVNW_USERNAME-}" ] || MVNW_USERNAME='' MVNW_PASSWORD='' ;; +esac + +if [ -z "${MVNW_USERNAME-}" ] && command -v wget >/dev/null; then + verbose "Found wget ... using wget" + wget ${__MVNW_QUIET_WGET:+"$__MVNW_QUIET_WGET"} "$distributionUrl" -O "$TMP_DOWNLOAD_DIR/$distributionUrlName" || die "wget: Failed to fetch $distributionUrl" +elif [ -z "${MVNW_USERNAME-}" ] && command -v curl >/dev/null; then + verbose "Found curl ... using curl" + curl ${__MVNW_QUIET_CURL:+"$__MVNW_QUIET_CURL"} -f -L -o "$TMP_DOWNLOAD_DIR/$distributionUrlName" "$distributionUrl" || die "curl: Failed to fetch $distributionUrl" +elif set_java_home; then + verbose "Falling back to use Java to download" + javaSource="$TMP_DOWNLOAD_DIR/Downloader.java" + targetZip="$TMP_DOWNLOAD_DIR/$distributionUrlName" + cat >"$javaSource" <<-END + public class Downloader extends java.net.Authenticator + { + protected java.net.PasswordAuthentication getPasswordAuthentication() + { + return new java.net.PasswordAuthentication( System.getenv( "MVNW_USERNAME" ), System.getenv( "MVNW_PASSWORD" ).toCharArray() ); + } + public static void main( String[] args ) throws Exception + { + setDefault( new Downloader() ); + java.nio.file.Files.copy( java.net.URI.create( args[0] ).toURL().openStream(), java.nio.file.Paths.get( args[1] ).toAbsolutePath().normalize() ); + } + } + END + # For Cygwin/MinGW, switch paths to Windows format before running javac and java + verbose " - Compiling Downloader.java ..." + "$(native_path "$JAVACCMD")" "$(native_path "$javaSource")" || die "Failed to compile Downloader.java" + verbose " - Running Downloader.java ..." + "$(native_path "$JAVACMD")" -cp "$(native_path "$TMP_DOWNLOAD_DIR")" Downloader "$distributionUrl" "$(native_path "$targetZip")" +fi + +# If specified, validate the SHA-256 sum of the Maven distribution zip file +if [ -n "${distributionSha256Sum-}" ]; then + distributionSha256Result=false + if [ "$MVN_CMD" = mvnd.sh ]; then + echo "Checksum validation is not supported for maven-mvnd." >&2 + echo "Please disable validation by removing 'distributionSha256Sum' from your maven-wrapper.properties." >&2 + exit 1 + elif command -v sha256sum >/dev/null; then + if echo "$distributionSha256Sum $TMP_DOWNLOAD_DIR/$distributionUrlName" | sha256sum -c - >/dev/null 2>&1; then + distributionSha256Result=true + fi + elif command -v shasum >/dev/null; then + if echo "$distributionSha256Sum $TMP_DOWNLOAD_DIR/$distributionUrlName" | shasum -a 256 -c >/dev/null 2>&1; then + distributionSha256Result=true + fi + else + echo "Checksum validation was requested but neither 'sha256sum' or 'shasum' are available." >&2 + echo "Please install either command, or disable validation by removing 'distributionSha256Sum' from your maven-wrapper.properties." >&2 + exit 1 + fi + if [ $distributionSha256Result = false ]; then + echo "Error: Failed to validate Maven distribution SHA-256, your Maven distribution might be compromised." >&2 + echo "If you updated your Maven version, you need to update the specified distributionSha256Sum property." >&2 + exit 1 + fi +fi + +# unzip and move +if command -v unzip >/dev/null; then + unzip ${__MVNW_QUIET_UNZIP:+"$__MVNW_QUIET_UNZIP"} "$TMP_DOWNLOAD_DIR/$distributionUrlName" -d "$TMP_DOWNLOAD_DIR" || die "failed to unzip" +else + tar xzf${__MVNW_QUIET_TAR:+"$__MVNW_QUIET_TAR"} "$TMP_DOWNLOAD_DIR/$distributionUrlName" -C "$TMP_DOWNLOAD_DIR" || die "failed to untar" +fi + +# Find the actual extracted directory name (handles snapshots where filename != directory name) +actualDistributionDir="" + +# First try the expected directory name (for regular distributions) +if [ -d "$TMP_DOWNLOAD_DIR/$distributionUrlNameMain" ]; then + if [ -f "$TMP_DOWNLOAD_DIR/$distributionUrlNameMain/bin/$MVN_CMD" ]; then + actualDistributionDir="$distributionUrlNameMain" + fi +fi + +# If not found, search for any directory with the Maven executable (for snapshots) +if [ -z "$actualDistributionDir" ]; then + # enable globbing to iterate over items + set +f + for dir in "$TMP_DOWNLOAD_DIR"/*; do + if [ -d "$dir" ]; then + if [ -f "$dir/bin/$MVN_CMD" ]; then + actualDistributionDir="$(basename "$dir")" + break + fi + fi + done + set -f +fi + +if [ -z "$actualDistributionDir" ]; then + verbose "Contents of $TMP_DOWNLOAD_DIR:" + verbose "$(ls -la "$TMP_DOWNLOAD_DIR")" + die "Could not find Maven distribution directory in extracted archive" +fi + +verbose "Found extracted Maven distribution directory: $actualDistributionDir" +printf %s\\n "$distributionUrl" >"$TMP_DOWNLOAD_DIR/$actualDistributionDir/mvnw.url" +mv -- "$TMP_DOWNLOAD_DIR/$actualDistributionDir" "$MAVEN_HOME" || [ -d "$MAVEN_HOME" ] || die "fail to move MAVEN_HOME" + +clean || : +exec_maven "$@" diff --git a/mvnw.cmd b/mvnw.cmd new file mode 100644 index 00000000..5761d948 --- /dev/null +++ b/mvnw.cmd @@ -0,0 +1,189 @@ +<# : batch portion +@REM ---------------------------------------------------------------------------- +@REM Licensed to the Apache Software Foundation (ASF) under one +@REM or more contributor license agreements. See the NOTICE file +@REM distributed with this work for additional information +@REM regarding copyright ownership. The ASF licenses this file +@REM to you under the Apache License, Version 2.0 (the +@REM "License"); you may not use this file except in compliance +@REM with the License. You may obtain a copy of the License at +@REM +@REM http://www.apache.org/licenses/LICENSE-2.0 +@REM +@REM Unless required by applicable law or agreed to in writing, +@REM software distributed under the License is distributed on an +@REM "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +@REM KIND, either express or implied. See the License for the +@REM specific language governing permissions and limitations +@REM under the License. +@REM ---------------------------------------------------------------------------- + +@REM ---------------------------------------------------------------------------- +@REM Apache Maven Wrapper startup batch script, version 3.3.4 +@REM +@REM Optional ENV vars +@REM MVNW_REPOURL - repo url base for downloading maven distribution +@REM MVNW_USERNAME/MVNW_PASSWORD - user and password for downloading maven +@REM MVNW_VERBOSE - true: enable verbose log; others: silence the output +@REM ---------------------------------------------------------------------------- + +@IF "%__MVNW_ARG0_NAME__%"=="" (SET __MVNW_ARG0_NAME__=%~nx0) +@SET __MVNW_CMD__= +@SET __MVNW_ERROR__= +@SET __MVNW_PSMODULEP_SAVE=%PSModulePath% +@SET PSModulePath= +@FOR /F "usebackq tokens=1* delims==" %%A IN (`powershell -noprofile "& {$scriptDir='%~dp0'; $script='%__MVNW_ARG0_NAME__%'; icm -ScriptBlock ([Scriptblock]::Create((Get-Content -Raw '%~f0'))) -NoNewScope}"`) DO @( + IF "%%A"=="MVN_CMD" (set __MVNW_CMD__=%%B) ELSE IF "%%B"=="" (echo %%A) ELSE (echo %%A=%%B) +) +@SET PSModulePath=%__MVNW_PSMODULEP_SAVE% +@SET __MVNW_PSMODULEP_SAVE= +@SET __MVNW_ARG0_NAME__= +@SET MVNW_USERNAME= +@SET MVNW_PASSWORD= +@IF NOT "%__MVNW_CMD__%"=="" ("%__MVNW_CMD__%" %*) +@echo Cannot start maven from wrapper >&2 && exit /b 1 +@GOTO :EOF +: end batch / begin powershell #> + +$ErrorActionPreference = "Stop" +if ($env:MVNW_VERBOSE -eq "true") { + $VerbosePreference = "Continue" +} + +# calculate distributionUrl, requires .mvn/wrapper/maven-wrapper.properties +$distributionUrl = (Get-Content -Raw "$scriptDir/.mvn/wrapper/maven-wrapper.properties" | ConvertFrom-StringData).distributionUrl +if (!$distributionUrl) { + Write-Error "cannot read distributionUrl property in $scriptDir/.mvn/wrapper/maven-wrapper.properties" +} + +switch -wildcard -casesensitive ( $($distributionUrl -replace '^.*/','') ) { + "maven-mvnd-*" { + $USE_MVND = $true + $distributionUrl = $distributionUrl -replace '-bin\.[^.]*$',"-windows-amd64.zip" + $MVN_CMD = "mvnd.cmd" + break + } + default { + $USE_MVND = $false + $MVN_CMD = $script -replace '^mvnw','mvn' + break + } +} + +# apply MVNW_REPOURL and calculate MAVEN_HOME +# maven home pattern: ~/.m2/wrapper/dists/{apache-maven-,maven-mvnd--}/ +if ($env:MVNW_REPOURL) { + $MVNW_REPO_PATTERN = if ($USE_MVND -eq $False) { "/org/apache/maven/" } else { "/maven/mvnd/" } + $distributionUrl = "$env:MVNW_REPOURL$MVNW_REPO_PATTERN$($distributionUrl -replace "^.*$MVNW_REPO_PATTERN",'')" +} +$distributionUrlName = $distributionUrl -replace '^.*/','' +$distributionUrlNameMain = $distributionUrlName -replace '\.[^.]*$','' -replace '-bin$','' + +$MAVEN_M2_PATH = "$HOME/.m2" +if ($env:MAVEN_USER_HOME) { + $MAVEN_M2_PATH = "$env:MAVEN_USER_HOME" +} + +if (-not (Test-Path -Path $MAVEN_M2_PATH)) { + New-Item -Path $MAVEN_M2_PATH -ItemType Directory | Out-Null +} + +$MAVEN_WRAPPER_DISTS = $null +if ((Get-Item $MAVEN_M2_PATH).Target[0] -eq $null) { + $MAVEN_WRAPPER_DISTS = "$MAVEN_M2_PATH/wrapper/dists" +} else { + $MAVEN_WRAPPER_DISTS = (Get-Item $MAVEN_M2_PATH).Target[0] + "/wrapper/dists" +} + +$MAVEN_HOME_PARENT = "$MAVEN_WRAPPER_DISTS/$distributionUrlNameMain" +$MAVEN_HOME_NAME = ([System.Security.Cryptography.SHA256]::Create().ComputeHash([byte[]][char[]]$distributionUrl) | ForEach-Object {$_.ToString("x2")}) -join '' +$MAVEN_HOME = "$MAVEN_HOME_PARENT/$MAVEN_HOME_NAME" + +if (Test-Path -Path "$MAVEN_HOME" -PathType Container) { + Write-Verbose "found existing MAVEN_HOME at $MAVEN_HOME" + Write-Output "MVN_CMD=$MAVEN_HOME/bin/$MVN_CMD" + exit $? +} + +if (! $distributionUrlNameMain -or ($distributionUrlName -eq $distributionUrlNameMain)) { + Write-Error "distributionUrl is not valid, must end with *-bin.zip, but found $distributionUrl" +} + +# prepare tmp dir +$TMP_DOWNLOAD_DIR_HOLDER = New-TemporaryFile +$TMP_DOWNLOAD_DIR = New-Item -Itemtype Directory -Path "$TMP_DOWNLOAD_DIR_HOLDER.dir" +$TMP_DOWNLOAD_DIR_HOLDER.Delete() | Out-Null +trap { + if ($TMP_DOWNLOAD_DIR.Exists) { + try { Remove-Item $TMP_DOWNLOAD_DIR -Recurse -Force | Out-Null } + catch { Write-Warning "Cannot remove $TMP_DOWNLOAD_DIR" } + } +} + +New-Item -Itemtype Directory -Path "$MAVEN_HOME_PARENT" -Force | Out-Null + +# Download and Install Apache Maven +Write-Verbose "Couldn't find MAVEN_HOME, downloading and installing it ..." +Write-Verbose "Downloading from: $distributionUrl" +Write-Verbose "Downloading to: $TMP_DOWNLOAD_DIR/$distributionUrlName" + +$webclient = New-Object System.Net.WebClient +if ($env:MVNW_USERNAME -and $env:MVNW_PASSWORD) { + $webclient.Credentials = New-Object System.Net.NetworkCredential($env:MVNW_USERNAME, $env:MVNW_PASSWORD) +} +[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12 +$webclient.DownloadFile($distributionUrl, "$TMP_DOWNLOAD_DIR/$distributionUrlName") | Out-Null + +# If specified, validate the SHA-256 sum of the Maven distribution zip file +$distributionSha256Sum = (Get-Content -Raw "$scriptDir/.mvn/wrapper/maven-wrapper.properties" | ConvertFrom-StringData).distributionSha256Sum +if ($distributionSha256Sum) { + if ($USE_MVND) { + Write-Error "Checksum validation is not supported for maven-mvnd. `nPlease disable validation by removing 'distributionSha256Sum' from your maven-wrapper.properties." + } + Import-Module $PSHOME\Modules\Microsoft.PowerShell.Utility -Function Get-FileHash + if ((Get-FileHash "$TMP_DOWNLOAD_DIR/$distributionUrlName" -Algorithm SHA256).Hash.ToLower() -ne $distributionSha256Sum) { + Write-Error "Error: Failed to validate Maven distribution SHA-256, your Maven distribution might be compromised. If you updated your Maven version, you need to update the specified distributionSha256Sum property." + } +} + +# unzip and move +Expand-Archive "$TMP_DOWNLOAD_DIR/$distributionUrlName" -DestinationPath "$TMP_DOWNLOAD_DIR" | Out-Null + +# Find the actual extracted directory name (handles snapshots where filename != directory name) +$actualDistributionDir = "" + +# First try the expected directory name (for regular distributions) +$expectedPath = Join-Path "$TMP_DOWNLOAD_DIR" "$distributionUrlNameMain" +$expectedMvnPath = Join-Path "$expectedPath" "bin/$MVN_CMD" +if ((Test-Path -Path $expectedPath -PathType Container) -and (Test-Path -Path $expectedMvnPath -PathType Leaf)) { + $actualDistributionDir = $distributionUrlNameMain +} + +# If not found, search for any directory with the Maven executable (for snapshots) +if (!$actualDistributionDir) { + Get-ChildItem -Path "$TMP_DOWNLOAD_DIR" -Directory | ForEach-Object { + $testPath = Join-Path $_.FullName "bin/$MVN_CMD" + if (Test-Path -Path $testPath -PathType Leaf) { + $actualDistributionDir = $_.Name + } + } +} + +if (!$actualDistributionDir) { + Write-Error "Could not find Maven distribution directory in extracted archive" +} + +Write-Verbose "Found extracted Maven distribution directory: $actualDistributionDir" +Rename-Item -Path "$TMP_DOWNLOAD_DIR/$actualDistributionDir" -NewName $MAVEN_HOME_NAME | Out-Null +try { + Move-Item -Path "$TMP_DOWNLOAD_DIR/$MAVEN_HOME_NAME" -Destination $MAVEN_HOME_PARENT | Out-Null +} catch { + if (! (Test-Path -Path "$MAVEN_HOME" -PathType Container)) { + Write-Error "fail to move MAVEN_HOME" + } +} finally { + try { Remove-Item $TMP_DOWNLOAD_DIR -Recurse -Force | Out-Null } + catch { Write-Warning "Cannot remove $TMP_DOWNLOAD_DIR" } +} + +Write-Output "MVN_CMD=$MAVEN_HOME/bin/$MVN_CMD" diff --git a/pom.xml b/pom.xml index 6b7ade11..1448665c 100644 --- a/pom.xml +++ b/pom.xml @@ -4,16 +4,17 @@ xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> 4.0.0 - org.example - JavaTemplate + org.juv25d + JavaHttpServer 1.0-SNAPSHOT - 23 + 25 UTF-8 6.0.2 3.27.7 5.21.0 + @@ -63,24 +64,24 @@ 3.4.0 - org.apache.maven.plugins - maven-dependency-plugin - 3.9.0 - - - - properties - - - + org.apache.maven.plugins + maven-dependency-plugin + 3.9.0 + + + + properties + + + org.apache.maven.plugins maven-surefire-plugin 3.5.4 - - @{argLine} -javaagent:${org.mockito:mockito-core:jar} -Xshare:off - + + @{argLine} -Xshare:off + org.apache.maven.plugins @@ -118,6 +119,45 @@ + + com.diffplug.spotless + spotless-maven-plugin + 2.43.0 + + + + src/main/java/**/*.java + src/test/java/**/*.java + + + + + + + + + + org.pitest + pitest-maven + 1.22.0 + + + + org.pitest + pitest-junit5-plugin + 1.2.2 + + + + + + org.juv25d.* + + + org.juv25d.* + + + diff --git a/src/main/java/org/example/App.java b/src/main/java/org/juv25d/App.java similarity index 52% rename from src/main/java/org/example/App.java rename to src/main/java/org/juv25d/App.java index 165e5cd5..0df3c3d0 100644 --- a/src/main/java/org/example/App.java +++ b/src/main/java/org/juv25d/App.java @@ -1,7 +1,7 @@ -package org.example; +package org.juv25d; public class App { public static void main(String[] args) { - System.out.println("Hello There!"); + SocketServer.createSocket(); } } diff --git a/src/main/java/org/juv25d/HttpRequest.java b/src/main/java/org/juv25d/HttpRequest.java new file mode 100644 index 00000000..a6ecb497 --- /dev/null +++ b/src/main/java/org/juv25d/HttpRequest.java @@ -0,0 +1,12 @@ +package org.juv25d; + +import java.util.Map; + +public record HttpRequest( + String method, + String path, + String queryString, + String httpVersion, + Map headers, + byte[] body +) {} diff --git a/src/main/java/org/juv25d/SocketServer.java b/src/main/java/org/juv25d/SocketServer.java new file mode 100644 index 00000000..d04fc744 --- /dev/null +++ b/src/main/java/org/juv25d/SocketServer.java @@ -0,0 +1,55 @@ +package org.juv25d; + +import org.juv25d.parser.HttpParser; +import org.juv25d.logging.ServerLogging; + +import java.io.IOException; +import java.io.InputStream; +import java.net.ServerSocket; +import java.net.Socket; +import java.util.logging.Level; +import java.util.logging.Logger; + +public class SocketServer { + private final HttpParser httpParser; + + public SocketServer(HttpParser httpParser) { + this.httpParser = httpParser; + } + + private static final Logger logger = ServerLogging.getLogger(); + + static void createSocket() { + int port = 3000; + + try (ServerSocket serverSocket = new ServerSocket(port, 64)) { + + logger.info("Server started at port: " + serverSocket.getLocalPort()); + + while (true) { + Socket socket = serverSocket.accept(); + logger.info("Client connected from: " + socket.getInetAddress().getHostAddress()); + + Thread.ofVirtual().start(() -> handleClient(socket)); + } + + } catch (IOException e) { + logger.log(Level.SEVERE, "Server socket error: " + e); + } + } + + static void handleClient(Socket socket) { + try (socket) { + InputStream in = socket.getInputStream(); + + HttpParser parser = new HttpParser(); + HttpRequest request = parser.parse(in); + + logger.info("Method: " + request.method()); + logger.info("Path: " + request.path()); + + } catch (IOException e) { + logger.log(Level.WARNING, "Error handling client ",e); + } + } +} diff --git a/src/main/java/org/juv25d/http/HttpResponse.java b/src/main/java/org/juv25d/http/HttpResponse.java new file mode 100644 index 00000000..5818f57e --- /dev/null +++ b/src/main/java/org/juv25d/http/HttpResponse.java @@ -0,0 +1,41 @@ +package org.juv25d.http; + +import java.util.Collections; +import java.util.LinkedHashMap; +import java.util.Map; +import java.util.Objects; + +public class HttpResponse { + + private final int statusCode; + private final String statusText; + private final Map headers; + private final byte[] body; + + public HttpResponse(int statusCode, String statusText, Map headers, byte[] body) { + Objects.requireNonNull(statusText, "statusText must not be null"); + Objects.requireNonNull(headers, "headers must not be null"); + Objects.requireNonNull(body, "body must not be null"); + this.statusCode = statusCode; + this.statusText = statusText; + this.headers = Collections.unmodifiableMap(new LinkedHashMap<>(headers)); + this.body = body.clone(); + } + + public int statusCode(){ + return statusCode; + } + + public String statusText(){ + return statusText; + } + + public Map headers() { + return headers; + } + + public byte[] body(){ + return body.clone(); + } + +} diff --git a/src/main/java/org/juv25d/http/HttpResponseWriter.java b/src/main/java/org/juv25d/http/HttpResponseWriter.java new file mode 100644 index 00000000..08aa7ab9 --- /dev/null +++ b/src/main/java/org/juv25d/http/HttpResponseWriter.java @@ -0,0 +1,50 @@ +package org.juv25d.http; + +import java.io.IOException; +import java.io.OutputStream; +import java.nio.charset.StandardCharsets; +import java.util.Map; + +public class HttpResponseWriter { + + private HttpResponseWriter() { + } + + // This method should be called by SocketServer/ConnectionHandler later + public static void write(OutputStream out, HttpResponse response) throws IOException { + writeStatusLine(out, response); + writeHeaders(out, response.headers(), response.body()); + writeBody(out, response.body()); + out.flush(); + } + + private static void writeStatusLine(OutputStream out, HttpResponse response) throws IOException { + String statusLine = + "HTTP/1.1 " + response.statusCode() + " " + response.statusText() + "\r\n"; + out.write(statusLine.getBytes(StandardCharsets.UTF_8)); + } + + private static void writeHeaders( + OutputStream out, + Map headers, + byte[] body + ) throws IOException { + + for (Map.Entry header : headers.entrySet()) { + if (!header.getKey().equalsIgnoreCase("Content-Length")) { + String line = header.getKey() + ": " + header.getValue() + "\r\n"; + out.write(line.getBytes(StandardCharsets.UTF_8)); + } + } + + String contentLength = "Content-Length: " + body.length + "\r\n"; + out.write(contentLength.getBytes(StandardCharsets.UTF_8)); + + out.write("\r\n".getBytes(StandardCharsets.UTF_8)); + } + + + private static void writeBody(OutputStream out, byte[] body) throws IOException { + out.write(body); + } +} diff --git a/src/main/java/org/juv25d/logging/ServerLogging.java b/src/main/java/org/juv25d/logging/ServerLogging.java new file mode 100644 index 00000000..a365e3ee --- /dev/null +++ b/src/main/java/org/juv25d/logging/ServerLogging.java @@ -0,0 +1,38 @@ +package org.juv25d.logging; + +import java.util.logging.ConsoleHandler; +import java.util.logging.Level; +import java.util.logging.Logger; +import java.util.logging.SimpleFormatter; + +public class ServerLogging { + private static final Logger logger = Logger.getLogger(ServerLogging.class.getName()); + + static { + // Configure logger for simple output + logger.setUseParentHandlers(false); // Prevent logging to parent handlers + + if (logger.getHandlers().length == 0) { + ConsoleHandler handler = new ConsoleHandler(); + handler.setFormatter(new SimpleFormatter()); + logger.addHandler(handler); + } + + String levelName = System.getProperty( + "log.level", + System.getenv().getOrDefault("LOG_LEVEL", "INFO") + ); + + Level level = Level.parse(levelName.toUpperCase()); + + logger.setLevel(level); // Set default logging level + } + + private ServerLogging() { + // Utility class - prevent instantiation + } + + public static Logger getLogger() { + return logger; + } +} diff --git a/src/main/java/org/juv25d/parser/HttpParser.java b/src/main/java/org/juv25d/parser/HttpParser.java new file mode 100644 index 00000000..c4053e09 --- /dev/null +++ b/src/main/java/org/juv25d/parser/HttpParser.java @@ -0,0 +1,87 @@ +package org.juv25d.parser; + +import org.juv25d.HttpRequest; + +import java.io.IOException; +import java.io.InputStream; +import java.util.HashMap; +import java.util.Map; + +public class HttpParser { + public HttpRequest parse(InputStream in) throws IOException { + + // 1. Request Line + String requestLine = readLine(in); + if (requestLine == null || requestLine.isEmpty()) { + throw new IOException("The request is empty"); + } + + String[] parts = requestLine.split("\\s+"); + if (parts.length < 3) { + throw new IOException("Malformed request line: " + requestLine); + } + String method = parts[0]; + String fullPath = parts[1]; + String version = parts[2]; + + String path; + String query = null; + + int qIndex = fullPath.indexOf('?'); + if (qIndex >= 0) { + path = fullPath.substring(0, qIndex); + query = fullPath.substring(qIndex + 1); + } else { + path = fullPath; + } + + // 2. Headers + Map headers = new HashMap<>(); + String line; + while ((line = readLine(in)) != null && !line.isEmpty()) { + int colon = line.indexOf(':'); + if (colon < 0) { + throw new IOException("Malformed header line: " + line); + } + String key = line.substring(0, colon).trim().toLowerCase(); + String value = line.substring(colon + 1).trim(); + headers.put(key, value); + } + + // 3. Body + byte[] body = new byte[0]; + if (headers.containsKey("content-length")) { + int length; + try { + length = Integer.parseInt(headers.get("content-length")); + } catch (NumberFormatException e) { + throw new IOException("Invalid Content-Length: " + headers.get("content-length"), e); + } + if (length < 0) { + throw new IOException("Negative Content-Length: " + length); + } + body = in.readNBytes(length); + } + + return new HttpRequest(method, path, query, version, headers, body); + + } + + private String readLine(InputStream in) throws IOException { + StringBuilder sb = new StringBuilder(); + int b; + while ((b = in.read()) != -1) { + if (b == '\n') { + break; + } + if (b != '\r') { + sb.append((char) b); + } + } + + if (b == -1 && sb.isEmpty()) { + return null; + } + return sb.toString(); + } +} diff --git a/src/test/java/org/example/AppIT.java b/src/test/java/org/juv25d/AppIT.java similarity index 90% rename from src/test/java/org/example/AppIT.java rename to src/test/java/org/juv25d/AppIT.java index 9d1ca031..521f0bf7 100644 --- a/src/test/java/org/example/AppIT.java +++ b/src/test/java/org/juv25d/AppIT.java @@ -1,4 +1,4 @@ -package org.example; +package org.juv25d; import org.junit.jupiter.api.Test; diff --git a/src/test/java/org/example/AppTest.java b/src/test/java/org/juv25d/AppTest.java similarity index 89% rename from src/test/java/org/example/AppTest.java rename to src/test/java/org/juv25d/AppTest.java index d522a7e2..5e1d4d23 100644 --- a/src/test/java/org/example/AppTest.java +++ b/src/test/java/org/juv25d/AppTest.java @@ -1,4 +1,4 @@ -package org.example; +package org.juv25d; import org.junit.jupiter.api.Test; diff --git a/src/test/java/org/juv25d/http/HttpResponseWriterTest.java b/src/test/java/org/juv25d/http/HttpResponseWriterTest.java new file mode 100644 index 00000000..aa5504a1 --- /dev/null +++ b/src/test/java/org/juv25d/http/HttpResponseWriterTest.java @@ -0,0 +1,59 @@ +package org.juv25d.http; + +import org.junit.jupiter.api.DisplayName; +import org.junit.jupiter.api.Test; + +import java.io.ByteArrayOutputStream; +import java.nio.charset.StandardCharsets; +import java.util.Map; + +import static org.assertj.core.api.AssertionsForClassTypes.assertThat; + +public class HttpResponseWriterTest { + + + @Test + @DisplayName("Should write a valid HTTP 200 OK response ") + void writesValidHttp200Response() throws Exception { + // Arrange + HttpResponse response = new HttpResponse( + 200, + "OK", + Map.of("Content-Type", "text/plain"), + "Hello World".getBytes(StandardCharsets.UTF_8) + ); + + ByteArrayOutputStream out = new ByteArrayOutputStream(); + + // Act + HttpResponseWriter.write(out, response); + + // Assert + String result = out.toString(StandardCharsets.UTF_8); + + assertThat(result).startsWith("HTTP/1.1 200 OK"); + assertThat(result).contains("Content-Type: text/plain"); + assertThat(result).contains("Content-Length: 11"); + assertThat(result).endsWith("Hello World"); + } + + @Test + @DisplayName("Should write a valid HTTP 404 Not Found Response") + void writes404NotFoundResponse() throws Exception { + HttpResponse response = new HttpResponse( + 404, + "Not Found", + Map.of("Content-Type", "text/plain"), + "Not found".getBytes(StandardCharsets.UTF_8) + ); + + ByteArrayOutputStream out = new ByteArrayOutputStream(); + + HttpResponseWriter.write(out, response); + + String result = out.toString(StandardCharsets.UTF_8); + + assertThat(result).startsWith("HTTP/1.1 404 Not Found"); + } + +}