From 609214ef4536f0099a31d50558b574ff2744200f Mon Sep 17 00:00:00 2001 From: upendrakumbham Date: Sat, 18 Apr 2026 17:44:51 +0100 Subject: [PATCH 1/5] Added pom.xml file and required dependencies to enable java,springboot in the project (#1) --- pom.xml | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) create mode 100644 pom.xml diff --git a/pom.xml b/pom.xml new file mode 100644 index 0000000..6c34601 --- /dev/null +++ b/pom.xml @@ -0,0 +1,32 @@ + + 4.0.0 + + com.tpximpact + url_shortener_api + 1.0 + + + org.springframework.boot + spring-boot-starter-parent + 3.2.0 + + + + 17 + + + + + + org.springframework.boot + spring-boot-starter + + + + + org.springframework.boot + spring-boot-starter-web + + + + From 471cbac6dd5ef95aa5f722d3cbd2c55eff25fdcb Mon Sep 17 00:00:00 2001 From: upendrakumbham Date: Wed, 22 Apr 2026 18:59:51 +0100 Subject: [PATCH 2/5] URL Shortener Rest API Endpoints (#2) * Added application entry point class * Added UrlController class * Added serviceImpl class and implemnetents with interface UrlService * Used constructor-based dependency injection in controller to inject UrlService * Integrated Spring Data JPA in DAO layer for database operations and added Lombok to reduce boilerplate code * Added PostgreSQL dependency to enable persistent data storage * Added H2 DB and removed unused dependency * Added Spring boot application yaml file for the dev and required configuration for the url shorten application * Added JPA Entity class to create a table with columns, Request and Response dto classes to carry data * Implemented POST endpoint to create shorten url as per api spec * Added custom exception classes and global exception handlers for the application * Implemented GET endpoint to redirect to full url by alias name * To see hibenate generated queries on the console for the testing * Added helper methods to generate alias and extract bsse url from the full url * Updated service with util * Tweak util class to return proper base url with slash * Implemented GET endpoint to get list of urls * Implemented GET endpoint to return list of urls * Removed unused imports * Removed baseUrl method from the util class. Moved back to static base url to use for the shorten url endpoint as per spec * Changed error message as per spec * Implemented delete endpoint * Removed unused import * A little cleanup * Format code --- pom.xml | 39 ++++++++-- .../urlshortener/UrlShortenerApplication.java | 13 ++++ .../controller/UrlController.java | 53 ++++++++++++++ .../urlshortener/dto/UrlListResponse.java | 7 ++ .../urlshortener/dto/UrlRequest.java | 8 +++ .../urlshortener/dto/UrlResponse.java | 5 ++ .../tpximpact/urlshortener/entity/Url.java | 35 +++++++++ .../exception/BadRequestException.java | 5 ++ .../exception/GlobalExceptionHandler.java | 19 +++++ .../exception/NotFoundException.java | 7 ++ .../repository/UrlRepository.java | 15 ++++ .../urlshortener/service/UrlService.java | 18 +++++ .../urlshortener/service/UrlServiceImpl.java | 71 +++++++++++++++++++ .../tpximpact/urlshortener/util/UrlUtils.java | 13 ++++ src/main/resources/application-dev.yaml | 16 +++++ 15 files changed, 317 insertions(+), 7 deletions(-) create mode 100644 src/main/java/com/tpximpact/urlshortener/UrlShortenerApplication.java create mode 100644 src/main/java/com/tpximpact/urlshortener/controller/UrlController.java create mode 100644 src/main/java/com/tpximpact/urlshortener/dto/UrlListResponse.java create mode 100644 src/main/java/com/tpximpact/urlshortener/dto/UrlRequest.java create mode 100644 src/main/java/com/tpximpact/urlshortener/dto/UrlResponse.java create mode 100644 src/main/java/com/tpximpact/urlshortener/entity/Url.java create mode 100644 src/main/java/com/tpximpact/urlshortener/exception/BadRequestException.java create mode 100644 src/main/java/com/tpximpact/urlshortener/exception/GlobalExceptionHandler.java create mode 100644 src/main/java/com/tpximpact/urlshortener/exception/NotFoundException.java create mode 100644 src/main/java/com/tpximpact/urlshortener/repository/UrlRepository.java create mode 100644 src/main/java/com/tpximpact/urlshortener/service/UrlService.java create mode 100644 src/main/java/com/tpximpact/urlshortener/service/UrlServiceImpl.java create mode 100644 src/main/java/com/tpximpact/urlshortener/util/UrlUtils.java create mode 100644 src/main/resources/application-dev.yaml diff --git a/pom.xml b/pom.xml index 6c34601..8b415da 100644 --- a/pom.xml +++ b/pom.xml @@ -2,8 +2,8 @@ 4.0.0 com.tpximpact - url_shortener_api - 1.0 + url_shortener + 1.0.0 org.springframework.boot @@ -16,17 +16,42 @@ - + org.springframework.boot - spring-boot-starter + spring-boot-starter-web - + org.springframework.boot - spring-boot-starter-web + spring-boot-starter-data-jpa - + + + com.h2database + h2 + runtime + + + + + org.springframework.boot + spring-boot-starter-validation + + + + + org.springframework.boot + spring-boot-starter-actuator + + + + + org.projectlombok + lombok + true + + diff --git a/src/main/java/com/tpximpact/urlshortener/UrlShortenerApplication.java b/src/main/java/com/tpximpact/urlshortener/UrlShortenerApplication.java new file mode 100644 index 0000000..cdf3eb6 --- /dev/null +++ b/src/main/java/com/tpximpact/urlshortener/UrlShortenerApplication.java @@ -0,0 +1,13 @@ +package com.tpximpact.urlshortener; + +import org.springframework.boot.SpringApplication; +import org.springframework.boot.autoconfigure.SpringBootApplication; + +@SpringBootApplication +class UrlShortenerApplication { + + public static void main(String[] args) { + SpringApplication.run(UrlShortenerApplication.class, args); + } + +} diff --git a/src/main/java/com/tpximpact/urlshortener/controller/UrlController.java b/src/main/java/com/tpximpact/urlshortener/controller/UrlController.java new file mode 100644 index 0000000..a46cb26 --- /dev/null +++ b/src/main/java/com/tpximpact/urlshortener/controller/UrlController.java @@ -0,0 +1,53 @@ +package com.tpximpact.urlshortener.controller; + +import com.tpximpact.urlshortener.dto.UrlListResponse; +import com.tpximpact.urlshortener.dto.UrlRequest; +import com.tpximpact.urlshortener.dto.UrlResponse; +import com.tpximpact.urlshortener.service.UrlService; +import jakarta.validation.Valid; +import lombok.RequiredArgsConstructor; +import lombok.extern.slf4j.Slf4j; +import org.springframework.http.ResponseEntity; +import org.springframework.web.bind.annotation.DeleteMapping; +import org.springframework.web.bind.annotation.GetMapping; +import org.springframework.web.bind.annotation.PathVariable; +import org.springframework.web.bind.annotation.PostMapping; +import org.springframework.web.bind.annotation.RequestBody; +import org.springframework.web.bind.annotation.RestController; +import java.net.URI; +import java.util.List; + +@RestController +@RequiredArgsConstructor +@Slf4j +class UrlController { + private final UrlService urlService; + + @PostMapping("/shorten") + public ResponseEntity shorten(@RequestBody @Valid UrlRequest request) { + UrlResponse response = urlService.shorten(request); + return ResponseEntity.status(201).body(response); + } + + @GetMapping("/{alias}") + public ResponseEntity redirect(@PathVariable String alias) { + log.info("Contacting urlService to full url with: {}", alias); + String fullUrl = urlService.getFullUrl(alias); + log.info("Received Full url to redirect: {}", fullUrl); + return ResponseEntity.status(302) + .location(URI.create(fullUrl)) + .build(); + } + + @GetMapping("/urls") + public ResponseEntity> getAll() { + return ResponseEntity.ok(urlService.getAll()); + } + + @DeleteMapping("/{alias}") + public ResponseEntity delete(@PathVariable String alias) { + urlService.delete(alias); + return ResponseEntity.noContent().build(); + } + +} diff --git a/src/main/java/com/tpximpact/urlshortener/dto/UrlListResponse.java b/src/main/java/com/tpximpact/urlshortener/dto/UrlListResponse.java new file mode 100644 index 0000000..f61f25a --- /dev/null +++ b/src/main/java/com/tpximpact/urlshortener/dto/UrlListResponse.java @@ -0,0 +1,7 @@ +package com.tpximpact.urlshortener.dto; + +public record UrlListResponse( + String alias, + String fullUrl, + String shortUrl +) {} \ No newline at end of file diff --git a/src/main/java/com/tpximpact/urlshortener/dto/UrlRequest.java b/src/main/java/com/tpximpact/urlshortener/dto/UrlRequest.java new file mode 100644 index 0000000..79bb75b --- /dev/null +++ b/src/main/java/com/tpximpact/urlshortener/dto/UrlRequest.java @@ -0,0 +1,8 @@ +package com.tpximpact.urlshortener.dto; + +import jakarta.validation.constraints.NotBlank; + +public record UrlRequest ( + @NotBlank String fullUrl, + String customAlias +) {} diff --git a/src/main/java/com/tpximpact/urlshortener/dto/UrlResponse.java b/src/main/java/com/tpximpact/urlshortener/dto/UrlResponse.java new file mode 100644 index 0000000..9c9d7d9 --- /dev/null +++ b/src/main/java/com/tpximpact/urlshortener/dto/UrlResponse.java @@ -0,0 +1,5 @@ +package com.tpximpact.urlshortener.dto; + +public record UrlResponse( + String shortUrl +) {} diff --git a/src/main/java/com/tpximpact/urlshortener/entity/Url.java b/src/main/java/com/tpximpact/urlshortener/entity/Url.java new file mode 100644 index 0000000..8dff426 --- /dev/null +++ b/src/main/java/com/tpximpact/urlshortener/entity/Url.java @@ -0,0 +1,35 @@ +package com.tpximpact.urlshortener.entity; + +import jakarta.persistence.Column; +import jakarta.persistence.Entity; +import jakarta.persistence.GeneratedValue; +import jakarta.persistence.GenerationType; +import jakarta.persistence.Id; +import jakarta.persistence.Table; +import jakarta.persistence.UniqueConstraint; +import lombok.AllArgsConstructor; +import lombok.Builder; +import lombok.Getter; +import lombok.NoArgsConstructor; +import lombok.Setter; + +@Entity +@Table(name = "urls", uniqueConstraints = { + @UniqueConstraint(columnNames = "alias") +}) +@Getter +@Setter +@NoArgsConstructor +@AllArgsConstructor +@Builder +public class Url { + @Id + @GeneratedValue(strategy = GenerationType.IDENTITY) + private Long id; + + @Column(nullable = false) + private String fullUrl; + + @Column(nullable = false, unique = true) + private String alias; +} diff --git a/src/main/java/com/tpximpact/urlshortener/exception/BadRequestException.java b/src/main/java/com/tpximpact/urlshortener/exception/BadRequestException.java new file mode 100644 index 0000000..0490e90 --- /dev/null +++ b/src/main/java/com/tpximpact/urlshortener/exception/BadRequestException.java @@ -0,0 +1,5 @@ +package com.tpximpact.urlshortener.exception; + +public class BadRequestException extends RuntimeException { + public BadRequestException(String message) { super(message); } +} diff --git a/src/main/java/com/tpximpact/urlshortener/exception/GlobalExceptionHandler.java b/src/main/java/com/tpximpact/urlshortener/exception/GlobalExceptionHandler.java new file mode 100644 index 0000000..01c41b0 --- /dev/null +++ b/src/main/java/com/tpximpact/urlshortener/exception/GlobalExceptionHandler.java @@ -0,0 +1,19 @@ +package com.tpximpact.urlshortener.exception; + +import org.springframework.http.ResponseEntity; +import org.springframework.web.bind.annotation.ExceptionHandler; +import org.springframework.web.bind.annotation.RestControllerAdvice; + +@RestControllerAdvice +public class GlobalExceptionHandler { + + @ExceptionHandler(BadRequestException.class) + public ResponseEntity handleBadRequest(BadRequestException ex) { + return ResponseEntity.badRequest().body(ex.getMessage()); + } + + @ExceptionHandler(NotFoundException.class) + public ResponseEntity handleNotFound(NotFoundException ex) { + return ResponseEntity.status(404).body(ex.getMessage()); + } +} diff --git a/src/main/java/com/tpximpact/urlshortener/exception/NotFoundException.java b/src/main/java/com/tpximpact/urlshortener/exception/NotFoundException.java new file mode 100644 index 0000000..5042cfb --- /dev/null +++ b/src/main/java/com/tpximpact/urlshortener/exception/NotFoundException.java @@ -0,0 +1,7 @@ +package com.tpximpact.urlshortener.exception; + +public class NotFoundException extends RuntimeException { + public NotFoundException(String message) { + super(message); + } +} diff --git a/src/main/java/com/tpximpact/urlshortener/repository/UrlRepository.java b/src/main/java/com/tpximpact/urlshortener/repository/UrlRepository.java new file mode 100644 index 0000000..877be95 --- /dev/null +++ b/src/main/java/com/tpximpact/urlshortener/repository/UrlRepository.java @@ -0,0 +1,15 @@ +package com.tpximpact.urlshortener.repository; + +import com.tpximpact.urlshortener.entity.Url; +import org.springframework.data.jpa.repository.JpaRepository; +import org.springframework.stereotype.Repository; + +import java.util.Optional; + +@Repository +public interface UrlRepository extends JpaRepository { + + boolean existsByAlias(String alias); + + Optional findByAlias(String alias); +} diff --git a/src/main/java/com/tpximpact/urlshortener/service/UrlService.java b/src/main/java/com/tpximpact/urlshortener/service/UrlService.java new file mode 100644 index 0000000..7b948ed --- /dev/null +++ b/src/main/java/com/tpximpact/urlshortener/service/UrlService.java @@ -0,0 +1,18 @@ +package com.tpximpact.urlshortener.service; + +import com.tpximpact.urlshortener.dto.UrlListResponse; +import com.tpximpact.urlshortener.dto.UrlRequest; +import com.tpximpact.urlshortener.dto.UrlResponse; + +import java.util.List; + +public interface UrlService { + + UrlResponse shorten(UrlRequest request); + + String getFullUrl(String alias); + + List getAll(); + + void delete(String alias); +} diff --git a/src/main/java/com/tpximpact/urlshortener/service/UrlServiceImpl.java b/src/main/java/com/tpximpact/urlshortener/service/UrlServiceImpl.java new file mode 100644 index 0000000..c9efd81 --- /dev/null +++ b/src/main/java/com/tpximpact/urlshortener/service/UrlServiceImpl.java @@ -0,0 +1,71 @@ +package com.tpximpact.urlshortener.service; + +import com.tpximpact.urlshortener.dto.UrlListResponse; +import com.tpximpact.urlshortener.dto.UrlRequest; +import com.tpximpact.urlshortener.dto.UrlResponse; +import com.tpximpact.urlshortener.entity.Url; +import com.tpximpact.urlshortener.exception.BadRequestException; +import com.tpximpact.urlshortener.exception.NotFoundException; +import com.tpximpact.urlshortener.repository.UrlRepository; +import com.tpximpact.urlshortener.util.UrlUtils; +import lombok.RequiredArgsConstructor; +import lombok.extern.slf4j.Slf4j; +import org.springframework.stereotype.Service; + +import java.util.List; + +@Slf4j +@Service +@RequiredArgsConstructor +public class UrlServiceImpl implements UrlService { + private static final String BASE_URL = "http://localhost:8080/"; + private final UrlRepository urlRepository; + + @Override + public UrlResponse shorten(UrlRequest request) { + + String alias = request.customAlias() != null + ? request.customAlias() : UrlUtils.generateAlias(); + + if (urlRepository.existsByAlias(alias)) { + throw new BadRequestException("Invalid input or alias already taken"); + } + + Url url = Url + .builder() + .fullUrl(request.fullUrl()) + .alias(alias) + .build(); + + urlRepository.save(url); + + return new UrlResponse(BASE_URL + alias); + } + + @Override + public String getFullUrl(String alias) { + log.info("Getting full url for alias ' {} ' from the DB", alias); + return urlRepository.findByAlias(alias) + .map(Url::getFullUrl) + .orElseThrow(() -> new NotFoundException("Alias not found")); + } + + @Override + public List getAll() { + return urlRepository.findAll().stream() + .map(url -> new UrlListResponse( + url.getAlias(), + url.getFullUrl(), + BASE_URL + url.getAlias() + )) + .toList(); + } + + public void delete(String alias) { + + Url url = urlRepository.findByAlias(alias) + .orElseThrow(() -> new NotFoundException("Alias not found")); + log.info("Deleting shorten url for alias '{}' from the DB", url.getAlias()); + urlRepository.delete(url); + } +} diff --git a/src/main/java/com/tpximpact/urlshortener/util/UrlUtils.java b/src/main/java/com/tpximpact/urlshortener/util/UrlUtils.java new file mode 100644 index 0000000..46e50cf --- /dev/null +++ b/src/main/java/com/tpximpact/urlshortener/util/UrlUtils.java @@ -0,0 +1,13 @@ +package com.tpximpact.urlshortener.util; + +import lombok.extern.slf4j.Slf4j; + +import java.util.UUID; + +@Slf4j +public class UrlUtils { + + public static String generateAlias() { + return UUID.randomUUID().toString().substring(0, 6); + } +} diff --git a/src/main/resources/application-dev.yaml b/src/main/resources/application-dev.yaml new file mode 100644 index 0000000..819ffce --- /dev/null +++ b/src/main/resources/application-dev.yaml @@ -0,0 +1,16 @@ +spring: + datasource: + url: jdbc:h2:file:./data/mydb + driver-class-name: org.h2.Driver + username: sa + password: + + h2: + console: + enabled: true + path: /h2-console + + jpa: + show_sql: true + hibernate: + ddl-auto: update From 021b1edd8916d60b1c9aefe91da15c097d014dae Mon Sep 17 00:00:00 2001 From: upendrakumbham Date: Sun, 26 Apr 2026 15:49:55 +0100 Subject: [PATCH 3/5] Feature/add url shortener api tests (#3) * Added H2 data files * Added springboot starter test dependency * Added service layer unit tests * Updated H2 Db as part of testing * Upgraded parent starter dependency to 4.0.1 from 3.2.0, 3.0.2 is in the end of life phase(deprecated).Good to upgrade before tests, save tests fixing time. * Upgraded parent starter dependency to 4.0.5 from 4.0.1 to remove vulnerabilities warnings. * Moved back to 3.5.0 to avoid modularised tech saperation package issues * Added web integration(E2E) tests * Added controller unit tests * Added controller integration Mockmvc tests to verify API flow, especially redirection endpoint testing. * Removed unused variable * Rename DB and added more capabilities * We don't need @Transactional, data jpa handles that. * Remove unused import * Commit DB data * Added test properties file --- data/mydb.mv.db | Bin 0 -> 32768 bytes data/mydb.trace.db | 73 ++++++++++ pom.xml | 10 +- src/main/resources/application-dev.yaml | 2 +- .../UrlControllerIntegrationTest.java | 76 +++++++++++ .../controller/UrlControllerTest.java | 125 ++++++++++++++++++ .../controller/UrlControllerWIT.java | 90 +++++++++++++ .../service/UrlServiceImplTest.java | 92 +++++++++++++ src/test/resources/application-test.yaml | 10 ++ 9 files changed, 476 insertions(+), 2 deletions(-) create mode 100644 data/mydb.mv.db create mode 100644 data/mydb.trace.db create mode 100644 src/test/java/com/tpximpact/urlshortener/controller/UrlControllerIntegrationTest.java create mode 100644 src/test/java/com/tpximpact/urlshortener/controller/UrlControllerTest.java create mode 100644 src/test/java/com/tpximpact/urlshortener/controller/UrlControllerWIT.java create mode 100644 src/test/java/com/tpximpact/urlshortener/service/UrlServiceImplTest.java create mode 100644 src/test/resources/application-test.yaml diff --git a/data/mydb.mv.db b/data/mydb.mv.db new file mode 100644 index 0000000000000000000000000000000000000000..98a638489001b4dfa48009197c1f498845b8f35f GIT binary patch literal 32768 zcmeHP-EP~+6{h^lWY@cG(6m6WxY}eBV-q1p&Ci){M&$YV zj&@48;CFib%aR+PoBLmh5;9G*z+awpzbp~#7I;UnZV46mkzjohl#mzr$iXIYL?P@Q z9k71MD!dX$$NRmmY!G%tpT87GCFHowCoa9IsXv8)LO>y)5Kssx1QY@a0fm4hapb$_9Cy)5KstwUkIc@e!I{SUGN1Q zvKQjGBzDe-%=V30!buaSQ7f zG6R=V0vFunm?GUGrtb$N&}~n+f`&-9ePY`#RJJ+hwk@a*lXP6)Bs!s{MX^r`TuPLUIYj^pc; z5#|IA*QrlEN^Dc7feYi6$5w0^gAcSI1XC60A zD|B?<201wKbnci4qrlWT!yI8N)VUv8CWxR1*hK-MR1c`&KBM+(5V)2rm@Z5!`nPmp zTTV!X4;LY~LlNqN`NG7mt%sPJ++;pngu+K4MF_B&wnsng9la>N#KnVG$Nk=sCw`~WWWD;Q#b+^tM+9=wq6NFN%{Z*)+1-)Ku(*xhuhV5s zYb`CuPpxT|d9=qqj8@z@>x=Ty5j#tJegi@-E=eJ$k@33KnF)<)gr9qdqpLc3pDZpc zEaY-?AKVz(q;gBudfgY7+D%u2-`p`#9Ts2vU{k9+@kKrNZKH6Wh%+8}WWn>Y*7KY2 z$^|uimmS{O==A&sD1=9%%f+4Ol|1*QnR|y1rkT{P=rcJVONm6xjE_EVR$9hpqf%~F+8cY-+LnQ_oj3Apzs<#WjlE{2VN|z``jeJX`Mla}HI00; zoHv@~TFbcSm;zK*#7zV$Eam<^W2fBQG4A=E9Uz-K%;t!iA!68}jsV?Th!7LU;Yb9W zT7-m@f3t6O}9}#)oUaNuWq2%)oFt z*_*9$qhJ*huxwp&ly67##p2Wwl208bm$U6_{fY2|rFhU9J= z?zVB>cv8=N7B5q@LhBzHch`<#`v5i*7ZcWg%h-HUZ?+ocXeozlJ-iw9pAq7|?AWN* zw<@1!>Yo?r9!%h?bX(V}u>3}}ZcSqgwsp0>*&1uV_i4Mjh|O2p4FCvT{O>R7sUNzA9wI!MPZDcpq^ zjmf5IxjVP@g?Cn?$58YX(opl@>;XRkYxdv)>+G}RwGUqQ`-jJ+hY!UmJ2>o!BJUkM zgtUjVhaJ!|AD$d_@MqAbFOK_hi(jP;*a7>h*F9g~iuxbceSm(M){btTuS*_NP6LX* zNULNeV1DnU?>we~ux#_<8t!9+gw3prYb@(K(a^t02YJ!!y+~#$#{k3W=RavIzPqZe zCVed@a;+qz=SDGGI1k9;=$zvbq2q-=-YzWVeylBnzp04j(OQYFEfk;PdqjTX$fGNd zR31Hf^yQJSblHI@w%?Vf{ca#mi*8(iw`pVyydyt>0=!}e*YKLXE${aZMYnaty2oJq zLPE=N+_cYpz{1QHtoLR8zBo99w>I?ko-ChqgI=xoqKM8Hu@tM+mV=Z=2Qi|ir9smq z)h4mXOYpKfUjdI-_(=AUh*|hjoRv~1QsEWrlu|F&U0E%j`*^L?o3kEwHkjFX&C~}r z=nwFdwNhVEGHUEHi-k+zzqm6eGY4yAig-e^#QhdGOICVvv&6$Dg-X3_Ih^A;FX!ZF z&dQOTpK}*1v|wS_jeouMuVw9qc0;;Hi{ObHT%p00wR!+bOmRP0iJYTF6rXT>BJs(O zPy8Rb)X{1t=~h@eTv6h1h0^{j@l-lrBcJPOi9rTdbZ-}~N4>CAdSOA03Bb#mdSS5_ z6i&J)$B>_uI%VTxxu0$$g0pE_ru5KK*D3TkKRIMwepWKAe-0!?iKPBH*Dx8A6xrY= zzED&FyKy%0#%!ZiL4=46sZ zZx;qx^dSntxC_lW1=2I!+)T#@wGQI{sXB_J3JR**X!u`hbCJ%H(dH~G$b|n%9RByD z8U#`E%wXT~65{`hm6iW!+Rbm#%Lf{|{g!Cx>E?;a8%jfez1=feL;u^r?y(bF!Z~O6 zKxts15&89y^qAD{LC*ACnQ`&#%ok`#oXJ=a*qoyU0Z+h>e>9WZf4aD?ivPb^+RIE! zb|n$F>Gp|=|6fFqy8bJyBvga~VDx3lVbeTmrm6E5ZY>r67vQ#3@qZQnALTA&0{;Kk z@&8f#duacYjQvl*{%6Z+rL z>>o6b`TuRj|5yC~afX@7HJCBaVkT{CI=fEU|H}R!O9GmZC!*|sW&aOy!e)97DKl~+ zjr{s!s1|PG!YTVdw*L*q|5yC~bGZv|i~TPX5)}XcHCYVbBme)V;{Sgu|NrS5leUt(pr^d#ZG#H^wrC2UmIh#r>GU&cheh$uFbsIde_5dUBJ(<-DsX7X|~dig*@ca(-MGlow~SEZp3x%5tAOT_6VlkA>^ zOCM29Qe$EgmtLyv6L=@%wvLmrbs&*9`VmSXp=2zGluI950%1Dc z- org.springframework.boot spring-boot-starter-parent - 3.2.0 + 3.5.0 @@ -53,5 +53,13 @@ lombok true + + + + org.springframework.boot + spring-boot-starter-test + test + + diff --git a/src/main/resources/application-dev.yaml b/src/main/resources/application-dev.yaml index 819ffce..4ea6c30 100644 --- a/src/main/resources/application-dev.yaml +++ b/src/main/resources/application-dev.yaml @@ -1,6 +1,6 @@ spring: datasource: - url: jdbc:h2:file:./data/mydb + url: jdbc:h2:file:./data/url-shorten-db;AUTO_SERVER=TRUE;DB_CLOSE_ON_EXIT=FALSE driver-class-name: org.h2.Driver username: sa password: diff --git a/src/test/java/com/tpximpact/urlshortener/controller/UrlControllerIntegrationTest.java b/src/test/java/com/tpximpact/urlshortener/controller/UrlControllerIntegrationTest.java new file mode 100644 index 0000000..a2d7cbb --- /dev/null +++ b/src/test/java/com/tpximpact/urlshortener/controller/UrlControllerIntegrationTest.java @@ -0,0 +1,76 @@ +package com.tpximpact.urlshortener.controller; + +import com.fasterxml.jackson.databind.ObjectMapper; +import com.tpximpact.urlshortener.dto.UrlRequest; +import org.junit.jupiter.api.DisplayName; +import org.junit.jupiter.api.Test; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.test.autoconfigure.web.servlet.AutoConfigureMockMvc; +import org.springframework.boot.test.context.SpringBootTest; +import org.springframework.http.MediaType; +import org.springframework.test.web.servlet.MockMvc; + +import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.delete; +import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get; +import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.post; +import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.content; +import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.header; +import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.jsonPath; +import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status; + +@SpringBootTest +@AutoConfigureMockMvc +class UrlControllerIntegrationTest { + + @Autowired + private MockMvc mockMvc; + + @Autowired + private ObjectMapper objectMapper; + + @Test + @DisplayName("Full integration flow: Create, Redirect, List, and Delete") + void testUrlLifecycle() throws Exception { + String longUrl = "https://www.tpximpact.com"; + String alias = "tpx"; + UrlRequest request = new UrlRequest(longUrl, alias); + + // 1. POST /shorten - Create a new mapping + mockMvc.perform(post("/shorten") + .contentType(MediaType.APPLICATION_JSON) + .content(objectMapper.writeValueAsString(request))) + .andExpect(status().isCreated()) + .andExpect(jsonPath("$.shortUrl").exists()); + + // 2. GET /{alias} - Test redirection logic + mockMvc.perform(get("/{alias}", alias)) + .andExpect(status().isFound()) // 302 + .andExpect(header().string("Location", longUrl)) + .andExpect(content().string("")); + + // 3. GET /urls - Verify the alias appears in the list + mockMvc.perform(get("/urls")) + .andExpect(status().isOk()) + .andExpect(jsonPath("$").isArray()) + .andExpect(jsonPath("$[?(@.alias == '" + alias + "')]").exists()); + + // 4. DELETE /{alias} - Remove the mapping + mockMvc.perform(delete("/{alias}", alias)) + .andExpect(status().isNoContent()); + + // 5. GET /{alias} - Verify it no longer exists (assuming service throws 404) + mockMvc.perform(get("/{alias}", alias)) + .andExpect(status().isNotFound()); + } + + @Test + @DisplayName("POST /shorten - Should return 400 when fullUrl is blank") + void shouldReturn400ForInvalidInput() throws Exception { + UrlRequest invalidRequest = new UrlRequest("", "short"); + + mockMvc.perform(post("/shorten") + .contentType(MediaType.APPLICATION_JSON) + .content(objectMapper.writeValueAsString(invalidRequest))) + .andExpect(status().isBadRequest()); + } +} \ No newline at end of file diff --git a/src/test/java/com/tpximpact/urlshortener/controller/UrlControllerTest.java b/src/test/java/com/tpximpact/urlshortener/controller/UrlControllerTest.java new file mode 100644 index 0000000..41a2cff --- /dev/null +++ b/src/test/java/com/tpximpact/urlshortener/controller/UrlControllerTest.java @@ -0,0 +1,125 @@ +package com.tpximpact.urlshortener.controller; + +import com.fasterxml.jackson.databind.ObjectMapper; +import com.tpximpact.urlshortener.dto.UrlListResponse; +import com.tpximpact.urlshortener.dto.UrlRequest; +import com.tpximpact.urlshortener.dto.UrlResponse; +import com.tpximpact.urlshortener.exception.NotFoundException; +import com.tpximpact.urlshortener.service.UrlService; +import org.junit.jupiter.api.DisplayName; +import org.junit.jupiter.api.Test; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.test.autoconfigure.web.servlet.WebMvcTest; +import org.springframework.test.context.bean.override.mockito.MockitoBean; // SB 4.0 standard +import org.springframework.http.MediaType; +import org.springframework.test.web.servlet.MockMvc; + +import java.util.List; + +import static org.mockito.ArgumentMatchers.any; +import static org.mockito.Mockito.*; +import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.*; +import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.*; + +@WebMvcTest(UrlController.class) +class UrlControllerTest { + + @Autowired + private MockMvc mockMvc; + + @Autowired + private ObjectMapper objectMapper; + + @MockitoBean + private UrlService urlService; + + @Test + @DisplayName("POST /shorten - Success") + void shortenUrl_Returns201() throws Exception { + // Given + UrlRequest request = new UrlRequest("https://example.com", "my-alias"); + UrlResponse response = new UrlResponse("http://localhost:8080/my-alias"); + + when(urlService.shorten(any(UrlRequest.class))).thenReturn(response); + + // When & Then + mockMvc.perform(post("/shorten") + .contentType(MediaType.APPLICATION_JSON) + .content(objectMapper.writeValueAsString(request))) + .andExpect(status().isCreated()) + .andExpect(jsonPath("$.shortUrl").value("http://localhost:8080/my-alias")); + + verify(urlService, times(1)).shorten(any(UrlRequest.class)); + } + + @Test + @DisplayName("GET /{alias} - Redirects to full URL") + void redirect_Returns302() throws Exception { + // Given + String alias = "tpx"; + String fullUrl = "https://tpximpact.com"; + when(urlService.getFullUrl(alias)).thenReturn(fullUrl); + + // When & Then + mockMvc.perform(get("/{alias}", alias)) + .andExpect(status().isFound()) + .andExpect(header().string("Location", fullUrl)) + .andExpect(content().string("")); // Asserting empty body as requested + + verify(urlService).getFullUrl(alias); + } + + @Test + @DisplayName("GET /{alias} - Redirects returns 404 if alias not exist") + void redirect_Returns404_If_Alias_Not_Exist() throws Exception { + // Given + String aliasNotExist = "notExist"; + when(urlService.getFullUrl(aliasNotExist)).thenThrow(NotFoundException.class); + + // When & Then + mockMvc.perform(get("/{alias}", aliasNotExist)) + .andExpect(status().isNotFound()); + + verify(urlService).getFullUrl(aliasNotExist); + } + + @Test + @DisplayName("GET /urls - Returns list of mappings") + void getAll_Returns200() throws Exception { + // Given + List mockList = List.of( + new UrlListResponse("alias1", "https://site1.com", "http://short/1"), + new UrlListResponse("alias2", "https://site2.com", "http://short/2") + ); + when(urlService.getAll()).thenReturn(mockList); + + // When & Then + mockMvc.perform(get("/urls")) + .andExpect(status().isOk()) + .andExpect(jsonPath("$.length()").value(2)) + .andExpect(jsonPath("$[0].alias").value("alias1")); + } + + @Test + @DisplayName("DELETE /{alias} - Success") + void delete_Returns204() throws Exception { + // When & Then + mockMvc.perform(delete("/{alias}", "old-alias")) + .andExpect(status().isNoContent()); + + verify(urlService).delete("old-alias"); + } + + @Test + @DisplayName("POST /shorten - Fails on invalid input") + void shortenUrl_BlankUrl_Returns400() throws Exception { + UrlRequest invalidRequest = new UrlRequest("", "alias"); + + mockMvc.perform(post("/shorten") + .contentType(MediaType.APPLICATION_JSON) + .content(objectMapper.writeValueAsString(invalidRequest))) + .andExpect(status().isBadRequest()); + + verifyNoInteractions(urlService); + } +} \ No newline at end of file diff --git a/src/test/java/com/tpximpact/urlshortener/controller/UrlControllerWIT.java b/src/test/java/com/tpximpact/urlshortener/controller/UrlControllerWIT.java new file mode 100644 index 0000000..f297346 --- /dev/null +++ b/src/test/java/com/tpximpact/urlshortener/controller/UrlControllerWIT.java @@ -0,0 +1,90 @@ +package com.tpximpact.urlshortener.controller; + +import com.tpximpact.urlshortener.dto.UrlListResponse; +import com.tpximpact.urlshortener.dto.UrlRequest; +import com.tpximpact.urlshortener.dto.UrlResponse; +import org.junit.jupiter.api.DisplayName; +import org.junit.jupiter.api.Test; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.test.context.SpringBootTest; +import org.springframework.boot.test.web.client.TestRestTemplate; +import org.springframework.http.HttpStatus; +import org.springframework.http.ResponseEntity; +import org.springframework.test.context.ActiveProfiles; + +import java.util.Arrays; +import java.util.List; + +import static org.assertj.core.api.Assertions.assertThat; + + +@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT) +@ActiveProfiles("test") +class UrlControllerWIT { + @Autowired + private TestRestTemplate restTemplate; + + + @Test + @DisplayName("POST /shorten - Should create short URL") + void shouldCreateShortUrl() { + // Given + UrlRequest request = new UrlRequest("https://tpximpact.com", "tpx"); + + // When + ResponseEntity response = restTemplate.postForEntity( + "/shorten", + request, + UrlResponse.class + ); + + // Then + assertThat(response.getStatusCode()).isEqualTo(HttpStatus.CREATED); + assertThat(response.getBody()).isNotNull(); + assertThat(response.getBody().shortUrl()).contains("/tpx"); + } + + @Test + @DisplayName("GET /{alias} - Should return 302 Redirect") + void shouldRedirect() { + // First, ensure the URL exists (Seed the data) + restTemplate.postForEntity("/shorten", new UrlRequest("https://google.com", "goog"), UrlResponse.class); + + // When - We use getForEntity + ResponseEntity response = restTemplate.getForEntity("/{alias}", Void.class, "goog"); + + // Then + assertThat(response.getStatusCode()).isEqualTo(HttpStatus.OK); + } + + @Test + @DisplayName("GET /urls - Should return list using TestRestTemplate") + void getAllRestTemplate() { + ResponseEntity response = restTemplate.getForEntity( + "/urls", + UrlListResponse[].class + ); + + assertThat(response.getStatusCode()).isEqualTo(HttpStatus.OK); + assertThat(response.getBody()).isNotNull(); + + // Convert array to list for easier assertions + List urls = Arrays.asList(response.getBody()); + assertThat(urls).isNotEmpty(); + assertThat(urls.get(0).alias()).isEqualTo("goog"); + + + } + + @Test + @DisplayName("DELETE /{alias} - Should remove entry") + void shouldDelete() { + // When + restTemplate.delete("/{alias}", "tpx"); + + // Then - Verify 404 after deletion + ResponseEntity response = restTemplate.getForEntity("/{alias}", Void.class, "tpx"); + assertThat(response.getStatusCode()).isEqualTo(HttpStatus.NOT_FOUND); + } + +} diff --git a/src/test/java/com/tpximpact/urlshortener/service/UrlServiceImplTest.java b/src/test/java/com/tpximpact/urlshortener/service/UrlServiceImplTest.java new file mode 100644 index 0000000..555efae --- /dev/null +++ b/src/test/java/com/tpximpact/urlshortener/service/UrlServiceImplTest.java @@ -0,0 +1,92 @@ +package com.tpximpact.urlshortener.service; + +import com.tpximpact.urlshortener.dto.UrlRequest; +import com.tpximpact.urlshortener.entity.Url; +import com.tpximpact.urlshortener.exception.BadRequestException; +import com.tpximpact.urlshortener.exception.NotFoundException; +import com.tpximpact.urlshortener.repository.UrlRepository; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.extension.ExtendWith; +import org.mockito.InjectMocks; +import org.mockito.Mock; + +import java.util.Optional; + +import static org.assertj.core.api.Assertions.assertThat; +import static org.assertj.core.api.Assertions.assertThatThrownBy; +import static org.mockito.Mockito.verify; +import static org.mockito.Mockito.when; + +@ExtendWith(org.mockito.junit.jupiter.MockitoExtension.class) +class UrlServiceImplTest { + + @Mock + private UrlRepository repository; + + @InjectMocks + private UrlServiceImpl service; + + private UrlRequest request; + private Url url; + + @BeforeEach + public void setUp() { + request = new UrlRequest("https://google.com", "alias1"); + + url = Url.builder() + .alias("alias1") + .fullUrl("https://google.com") + .build(); + } + + @Test + void shouldCreateShortUrl_withCustomAlias() { + + when(repository.existsByAlias("alias1")).thenReturn(false); + + var response = service.shorten(request); + + assertThat(response.shortUrl()).contains("alias1"); + verify(repository).existsByAlias("alias1"); + } + + @Test + void shouldThrowException_whenAliasAlreadyExists() { + + when(repository.existsByAlias("alias1")).thenReturn(true); + + assertThatThrownBy(() -> service.shorten(request)) + .isInstanceOf(BadRequestException.class) + .hasMessageContaining("Invalid input or alias already taken"); + } + + @Test + void shouldReturnFullUrl_whenAliasExists() { + + when(repository.findByAlias("alias1")).thenReturn(Optional.of(url)); + + var result = service.getFullUrl("alias1"); + + assertThat(result).isEqualTo("https://google.com"); + } + + @Test + void shouldThrowNotFound_whenAliasMissing() { + when(repository.findByAlias("abc")).thenReturn(Optional.empty()); + + assertThatThrownBy(() -> service.getFullUrl("abc")) + .isInstanceOf(NotFoundException.class); + } + + @Test + void shouldDelete_whenAliasExists() { + Url url = Url.builder().alias("abc").build(); + + when(repository.findByAlias("abc")).thenReturn(Optional.of(url)); + + service.delete("abc"); + + verify(repository).delete(url); + } +} \ No newline at end of file diff --git a/src/test/resources/application-test.yaml b/src/test/resources/application-test.yaml new file mode 100644 index 0000000..5421926 --- /dev/null +++ b/src/test/resources/application-test.yaml @@ -0,0 +1,10 @@ +spring: + datasource: + url: jdbc:h2:mem:testdb + driverClassName: org.h2.Driver + jpa: + hibernate: + ddl-auto: create-drop + h2: + console: + enabled: true \ No newline at end of file From 78f8ec1f7b4807e3b6e107733dd4edfa52fb5936 Mon Sep 17 00:00:00 2001 From: Upendra Kumbham Date: Sun, 26 Apr 2026 16:42:14 +0100 Subject: [PATCH 4/5] Maven plugin to build fat jar --- pom.xml | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/pom.xml b/pom.xml index db8dc06..d31506c 100644 --- a/pom.xml +++ b/pom.xml @@ -60,6 +60,14 @@ spring-boot-starter-test test - + + + + + org.springframework.boot + spring-boot-maven-plugin + + + From 4ac01be76f58eb19c039156fd311b40984ba57f1 Mon Sep 17 00:00:00 2001 From: upendrakumbham Date: Tue, 28 Apr 2026 12:50:05 +0100 Subject: [PATCH 5/5] Feature/dockerize application (#4) * Added connection pool details * Added plugin to run integrations tests through maven and renames classes as per maven * Added jacoco plugin to generate test coverage report and coverage threshold * Dockerized application * Added maven wrapper to run application without maven installation in your local environment * Added DB data file * Added .gitignore * Improved Readability and used var wherever applicable * Added CrossOrigin url to allow frontend origin to contact API * Added latest data * Removed unused DB files * Updated existing README on how to build and run frontend, backend applications * Added DB data file --- .gitignore | 3 + .mvn/wrapper/maven-wrapper.properties | 3 + Dockerfile | 18 + README.md | 314 ++++++++++++++++++ data/mydb.mv.db | Bin 32768 -> 0 bytes data/mydb.trace.db | 73 ---- data/shortener_db.lock.db | 6 + data/shortener_db.mv.db | Bin 0 -> 32768 bytes mvnw | 295 ++++++++++++++++ mvnw.cmd | 189 +++++++++++ pom.xml | 76 ++++- .../controller/UrlController.java | 2 + .../urlshortener/service/UrlServiceImpl.java | 24 +- src/main/resources/application-dev.yaml | 19 +- ...egrationTest.java => UrlControllerIT.java} | 4 +- 15 files changed, 939 insertions(+), 87 deletions(-) create mode 100644 .gitignore create mode 100644 .mvn/wrapper/maven-wrapper.properties create mode 100644 Dockerfile delete mode 100644 data/mydb.mv.db delete mode 100644 data/mydb.trace.db create mode 100644 data/shortener_db.lock.db create mode 100644 data/shortener_db.mv.db create mode 100755 mvnw create mode 100644 mvnw.cmd rename src/test/java/com/tpximpact/urlshortener/controller/{UrlControllerIntegrationTest.java => UrlControllerIT.java} (96%) diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..c3e7553 --- /dev/null +++ b/.gitignore @@ -0,0 +1,3 @@ +# Exclude the actual build output +target/ +.idea/ \ No newline at end of file diff --git a/.mvn/wrapper/maven-wrapper.properties b/.mvn/wrapper/maven-wrapper.properties new file mode 100644 index 0000000..c0bcafe --- /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.9.11/apache-maven-3.9.11-bin.zip diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000..f4db853 --- /dev/null +++ b/Dockerfile @@ -0,0 +1,18 @@ +# Stage 1: Build the application +FROM maven:3.9.6-eclipse-temurin-17 AS build +COPY . /app +WORKDIR /app +RUN mvn clean package -DskipTests + +# Stage 2: Run the application +FROM eclipse-temurin:17-jre-jammy +WORKDIR /app + +# Copy only the built jar from the build stage +COPY --from=build /app/target/url_shortener-1.0.0.jar app.jar + +# expose port +EXPOSE 8080 + +# run app +ENTRYPOINT ["java", "-jar", "app.jar"] \ No newline at end of file diff --git a/README.md b/README.md index a2fcc9b..c8e1882 100644 --- a/README.md +++ b/README.md @@ -42,3 +42,317 @@ It should: - How to build and run locally. - Example usage (frontend and API). - Any notes or assumptions. +----------------------------------------------------------- +------------------------------------------------------------- +# URL Shortener API (Spring Boot) + +A RESTful API for shortening URLs, retrieving them, redirecting, and deleting entries. + +--- + +## ๐Ÿš€ Features + +* Create short URLs (with optional custom alias) +* Redirect to original URL +* List all shortened URLs +* Delete URLs +* H2 (dev/test) +* Integration & unit tests +* Docker support + +--- + +## ๐Ÿ› ๏ธ Tech Stack + +* Java 17 +* Spring Boot 3.5 +* Spring Web (REST APIs) +* Spring Data JPA +* H2 Filebased mode +* Maven +* JaCoCo (code coverage) + +--- + +## ๐Ÿ“ฆ Prerequisites + +* Java 17+ +* Maven (or use Maven Wrapper `./mvnw`) +* Node.js (if running frontend) +* Docker (optional) + +--- + +## โš™๏ธ Getting Started + +### 1. Clone the repository + +```bash +git clone +cd url-shortener +``` + +--- + +### 2. Build the project + +```bash +./mvnw clean install +``` + +--- + +### 3. Run the application +Set SpringBoot Profile as an environment variable + +```bash +export SPRING_PROFILES_ACTIVE=dev +```` + +```bash +./mvnw spring-boot:run +``` +or +```bash +./mvnw spring-boot:run -Dspring-boot.run.profiles=dev +``` + +--- + +### 4. Access API + +```text +http://localhost:8080 +``` + +--- + +## ๐Ÿ”— API Endpoints + +### โž• Shorten URL + +```http +POST /shorten +``` + +**Request:** + +```json +{ + "fullUrl": "https://example.com", + "customAlias": "my-alias" +} +``` + +**Response (201):** + +```json +{ + "shortUrl": "http://localhost:8080/my-alias" +} +``` + +--- + +### ๐Ÿ” Redirect to Original URL + +```http +GET /{alias} +``` + +**Response:** + +* `302 Found` โ†’ Redirects to original URL +* `404 Not Found` โ†’ Alias does not exist + +--- + +### ๐Ÿ“‹ Get All URLs + +```http +GET /urls +``` + +**Response:** + +```json +[ + { + "alias": "my-alias", + "fullUrl": "https://example.com", + "shortUrl": "http://localhost:8080/my-alias" + } +] +``` + +--- + +### โŒ Delete URL + +```http +DELETE /{alias} +``` + +**Response:** + +* `204 No Content` โ†’ Successfully deleted +* `404 Not Found` โ†’ Alias not found + +--- +Access H2 console: + +```text +http://localhost:8080/h2-console + +``` + +## โš™๏ธ Profiles + +Run with different profiles: + +```bash +java -jar app.jar --spring.profiles.active=dev +``` + +Available profiles: + +* `dev` +* `test` +--- + +## ๐Ÿงช Running Tests + +### Unit tests + +```bash +./mvnw test +``` + +### Integration tests + +```bash +./mvnw verify +``` + +--- + +## ๐Ÿ“Š Code Coverage (JaCoCo) + +Generate report: + +```bash +./mvnw clean verify +``` + +Open report: + +```text +target/site/jacoco/index.html +``` +--- + +## ๐Ÿณ Docker + +### Build image + +```bash +docker build -t url-shortener . +``` + +### Run the Container by passing spring profile dev + +```bash +docker run -p 8080:8080 \ + -e SPRING_PROFILES_ACTIVE=dev \ + url-shortener +``` +Note: I'm not pusing docker image to DockerHub. Please build image from the Dockerfile and create a container from the image +## โš ๏ธ Common Issues + +### โŒ CORS errors + +Fix backend CORS configuration + +### โŒ Port already in use + +Change port: + +```yaml +server: + port: 8081 +``` + +### โŒ DB connection issues + +Check credentials and DB availability + +--- + +## ๐Ÿ’ก Future Improvements + +* URL expiration +* Analytics (click tracking) +* Reslience 4J +* Authentication (JWT) +* API Documentation +* Redis cache integration +* DB Migration +* DB indexing + +--- + +## Run frontend application + +1. Clone the repository + ```bash + git clone git@github.com:upendrakumbham/url-shortener-ui.git + cd url-shortener-ui + ``` +2. Install dependencies + npm install +3. Start the development server + npm run dev +4. Open the application + http://localhost:5173 + ๐Ÿ”— Backend Configuration + +The frontend expects the backend API to be running at: +http://localhost:8080 + +If your backend runs on a different port, update: +src/api/urlApi.js +const API_BASE = "http://localhost:8080"; + +### ๐ŸŒ CORS Configuration (IMPORTANT) +``` +Update your Spring Boot backend: + +@CrossOrigin(origins = "http://localhost:5173") +Public class UrlController +Or configure globally via WebMvcConfigurer. +Rerun backend API, make sure it is running. +``` +### ๐Ÿงช Available Scripts +``` +npm run dev # Start dev server +npm run build # Build production bundle +npm run preview # Preview production build +``` + +## ๐Ÿง‘โ€๐Ÿ’ป Author + +Upendra Kumbham + +--- + +## ๐Ÿ“„ License + +This project is implemented as part TpxImpact assignment. + + + + + + + + diff --git a/data/mydb.mv.db b/data/mydb.mv.db deleted file mode 100644 index 98a638489001b4dfa48009197c1f498845b8f35f..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 32768 zcmeHP-EP~+6{h^lWY@cG(6m6WxY}eBV-q1p&Ci){M&$YV zj&@48;CFib%aR+PoBLmh5;9G*z+awpzbp~#7I;UnZV46mkzjohl#mzr$iXIYL?P@Q z9k71MD!dX$$NRmmY!G%tpT87GCFHowCoa9IsXv8)LO>y)5Kssx1QY@a0fm4hapb$_9Cy)5KstwUkIc@e!I{SUGN1Q zvKQjGBzDe-%=V30!buaSQ7f zG6R=V0vFunm?GUGrtb$N&}~n+f`&-9ePY`#RJJ+hwk@a*lXP6)Bs!s{MX^r`TuPLUIYj^pc; z5#|IA*QrlEN^Dc7feYi6$5w0^gAcSI1XC60A zD|B?<201wKbnci4qrlWT!yI8N)VUv8CWxR1*hK-MR1c`&KBM+(5V)2rm@Z5!`nPmp zTTV!X4;LY~LlNqN`NG7mt%sPJ++;pngu+K4MF_B&wnsng9la>N#KnVG$Nk=sCw`~WWWD;Q#b+^tM+9=wq6NFN%{Z*)+1-)Ku(*xhuhV5s zYb`CuPpxT|d9=qqj8@z@>x=Ty5j#tJegi@-E=eJ$k@33KnF)<)gr9qdqpLc3pDZpc zEaY-?AKVz(q;gBudfgY7+D%u2-`p`#9Ts2vU{k9+@kKrNZKH6Wh%+8}WWn>Y*7KY2 z$^|uimmS{O==A&sD1=9%%f+4Ol|1*QnR|y1rkT{P=rcJVONm6xjE_EVR$9hpqf%~F+8cY-+LnQ_oj3Apzs<#WjlE{2VN|z``jeJX`Mla}HI00; zoHv@~TFbcSm;zK*#7zV$Eam<^W2fBQG4A=E9Uz-K%;t!iA!68}jsV?Th!7LU;Yb9W zT7-m@f3t6O}9}#)oUaNuWq2%)oFt z*_*9$qhJ*huxwp&ly67##p2Wwl208bm$U6_{fY2|rFhU9J= z?zVB>cv8=N7B5q@LhBzHch`<#`v5i*7ZcWg%h-HUZ?+ocXeozlJ-iw9pAq7|?AWN* zw<@1!>Yo?r9!%h?bX(V}u>3}}ZcSqgwsp0>*&1uV_i4Mjh|O2p4FCvT{O>R7sUNzA9wI!MPZDcpq^ zjmf5IxjVP@g?Cn?$58YX(opl@>;XRkYxdv)>+G}RwGUqQ`-jJ+hY!UmJ2>o!BJUkM zgtUjVhaJ!|AD$d_@MqAbFOK_hi(jP;*a7>h*F9g~iuxbceSm(M){btTuS*_NP6LX* zNULNeV1DnU?>we~ux#_<8t!9+gw3prYb@(K(a^t02YJ!!y+~#$#{k3W=RavIzPqZe zCVed@a;+qz=SDGGI1k9;=$zvbq2q-=-YzWVeylBnzp04j(OQYFEfk;PdqjTX$fGNd zR31Hf^yQJSblHI@w%?Vf{ca#mi*8(iw`pVyydyt>0=!}e*YKLXE${aZMYnaty2oJq zLPE=N+_cYpz{1QHtoLR8zBo99w>I?ko-ChqgI=xoqKM8Hu@tM+mV=Z=2Qi|ir9smq z)h4mXOYpKfUjdI-_(=AUh*|hjoRv~1QsEWrlu|F&U0E%j`*^L?o3kEwHkjFX&C~}r z=nwFdwNhVEGHUEHi-k+zzqm6eGY4yAig-e^#QhdGOICVvv&6$Dg-X3_Ih^A;FX!ZF z&dQOTpK}*1v|wS_jeouMuVw9qc0;;Hi{ObHT%p00wR!+bOmRP0iJYTF6rXT>BJs(O zPy8Rb)X{1t=~h@eTv6h1h0^{j@l-lrBcJPOi9rTdbZ-}~N4>CAdSOA03Bb#mdSS5_ z6i&J)$B>_uI%VTxxu0$$g0pE_ru5KK*D3TkKRIMwepWKAe-0!?iKPBH*Dx8A6xrY= zzED&FyKy%0#%!ZiL4=46sZ zZx;qx^dSntxC_lW1=2I!+)T#@wGQI{sXB_J3JR**X!u`hbCJ%H(dH~G$b|n%9RByD z8U#`E%wXT~65{`hm6iW!+Rbm#%Lf{|{g!Cx>E?;a8%jfez1=feL;u^r?y(bF!Z~O6 zKxts15&89y^qAD{LC*ACnQ`&#%ok`#oXJ=a*qoyU0Z+h>e>9WZf4aD?ivPb^+RIE! zb|n$F>Gp|=|6fFqy8bJyBvga~VDx3lVbeTmrm6E5ZY>r67vQ#3@qZQnALTA&0{;Kk z@&8f#duacYjQvl*{%6Z+rL z>>o6b`TuRj|5yC~afX@7HJCBaVkT{CI=fEU|H}R!O9GmZC!*|sW&aOy!e)97DKl~+ zjr{s!s1|PG!YTVdw*L*q|5yC~bGZv|i~TPX5)}XcHCYVbBme)V;{Sgu|NrS5leUt(pr^d#ZG#H^wrC2UmIh#r>GU&cheh$uFbsIde_5dUBJ(<-DsX7X|~dig*@ca(-MGlow~SEZp3x%5tAOT_6VlkA>^ zOCM29Qe$EgmtLyv6L=@%wvLmrbs&*9`VmSXp=2zGluI950%1Dc z-84c74CN8Nl#`npyfy6w7uT>%gF1g>i@P@XzbWYJmYu<+ZiU(3e!K;lV}|~ zayqjK(n>2da6($d0R#u&fcCOyPDqFYCnS)NIKT~YgDXM^ap84!m)*9LOlFe#VYYJU zuI}opdiAQ^{l4$L*I6wpdAHm5-Y**QzP0r&Qp5;2Pi>;2Pi>;2Pi> z;2Pi>;2Pi>;2L-ZG_cC?|0}QxTm-HGt^uwAt^uwAt^uwAt^uwAt^uwAt^uxr=c|Fl z$*Mj`NW0LMXttvtPtkfS|Bb)cpLQ-w(n6uR&Y@(kx9^^5NDtDQc>M1MH51 z0Q7v1?1x1+ANIW>)*K|C)gQzXod4DNP{>>nB&;Cc@Z3PcK0%gg>XL#K6|0seDVpI2 zs_9CK<@!3pP~{RrRANc0Mx4O*u%zlP@myb%G}XnXLR3j}Rn_o3OVTZ*x@v$W-9|of zR2>SA;UE*v5XW<{?MMc8EzkCeWN3kE+ZYNivaw?;lHvQRteH4IaC zB`a_gT|t^;8IQAFJ7v<15$(i3a z%EV6ze#iB`+k%HESTbwQ&gF8q?>0$52Bhba%h5yj%w>4zBr>d#(0M+?pZR>wyhA~l zUA?p_X3q;^W@a{fZcaKcyd__K(5klOrDnC%u6D}nwR%NXR3#_p79NZ7S$VxxZOXM} zxpB8GS0B_`?UtNtm2z^cRBy}Iz`z6BNU?*+phK>AOeVb62R6oz^t=X;t>RrKg zta|iUCoip*nx&;SX!U-n zxlwDZTvv2`aq{A2XxD)mJn{PZ#VhjL3m+z`U=pU(@NBZT+NEY&{(7ywDr31>O&=n; zT&>@2th74qyB(_ZtMXe5l|+Jj&Dt8wOTJUxNC}ag?ZDX%++TMask(Tbq9t0qCSO_D zg&PZ$bLeWqT~U#j?lxNOW+__B(PEEIM*XLRxK2BkYmG|vLF)Q(fv&>@4%iLfsKNTn z(ZaRl3f%Cu#!`E#{ra8Ss#$8U-Cl1kn|1S^wY+@Ksx9Act*ae6)=|?;?t-}coa?(EO3g!?;@$@%G}ugqM?3YnScX`|2!-rEero!#Qin^EH~DR}+un~vMx3)QI6 zk+mir?EZA)EFE!!Rlw+5+dE*vM;&K}!nwnGkdclFG4lsEyI}9#+#7TSA@lLV=B)T- zAq!x;pwO*)E-Gtwyz}CnPpfpgHR#r)TZ?XOx^>U>oNZF*T%^0Lo=^4*R(t?2!pOe7 zKx^Ot-j2gEydl3t&-ZsouRU;jyD$w1>)(x=hK>vBLg@qTbM*R$r-HxCCZ&o-jNR%5Y7>E@V zR?z0Q!I~*-`R5{DsDR_0GDnZ#rlos5-nqXJ6OIWbi6$}EgcGhw$#=INk$aSPis+{O zqUs@fZVk!_0p%tH6p$j(pRNxHC?zl~!^rRT_I4pdCFY~NtX`~C#j%Z)w0`h3(!xAJT3s#aZ8x_v<$cDZ-kj& z{toKl_^&^JJy@BKn{>}NTmxJKTmxJKTmxJKTmxJKTm!GD1}6OPzzoFM^!g~9-q0~v z%$jpnp7eA-^U3(e7>dv+4s+ZXed&m~|0%4&fFQ}x{jcD(``?J&|2jnjmKUUlI%OIB z|Ff&Jj|EO5a}xPP1bCV?<|HyFkr^=#FM=DhzZM%OA(1m5&;2WNC^O3_*_fFnlzV** znb~m$6;JSsPi9z;V|EQarYDn7DN25_=%&v&GfNI z%%Pqzhrqm!#r%yJPGuDT$EZUONLg@6M6rP5sOl z7sfV*X5t|!$mqhjM)jLvf&2eY@Bg2`-$VRwr0~CiRmFY2_&@e`GB09` z{~_9+zVb)---|qj*o0szhW|CJ1bFmfH)G=f{D|NUG(Gi{m_OY-#{b{p_@4)noh$(E zX#B4!JctY;6hFH`WPhBkh!@Vqp<(l{a%@<3{?6`Ze-M)1H=-aih+OOTJ*T_b-wlfv zvJed-18k#af0SvQn~aJZHa;XgPW=7sdozMGf|4w@$9PVd5+8yoAvEQ5n9>-%dJe~w z*M&}jRS?vQCKr%pnE8V|Gn5wvf^l9be19m{ull&VBx}?5M^{+xVRv^%&d*u)njL=Q^8iqbhHAo&PQ^KY`F%o}UL?c>SSo3%sl{~o&OPj<|NsZz}I12ES za3jV~!e)iyC*gxXy~Nxwj{nC#Gc$Etq~JBj|MdRl`2QC7{~z;Z8IJ#X{y)$EAEoZ| z{C}SR|1$Ic6a3Hc_YnW5{+phy`MM5YxjQS&pYDg@fB!`IpT_#3l=W^wioB8fAAm`4 zV2uC4L{ATO%5sGN|17*IfZs00|E~-Dhj|&|Uqo=<9Rcu<2KN6sA+Yy2upa``7vR(T zzXA4M0_?}Lf1U-{A4v_ykgcdCPl_o7=Z#nhkFkbN1MHJW60)X%eOxmQ?7#Uq2KK!# zMzO;j|40AjwP5Is1mynz5sCEzo)yRQR>z{dt-2c!0 s|J?sSA|3em|M>U+lJEZ|_@CkLA^!JA{(oEd1NhLXbxHtzX!H610nXAARsaA1 literal 0 HcmV?d00001 diff --git a/mvnw b/mvnw new file mode 100755 index 0000000..bd8896b --- /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 0000000..5761d94 --- /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 d31506c..82ac634 100644 --- a/pom.xml +++ b/pom.xml @@ -61,13 +61,87 @@ test - + + org.springframework.boot spring-boot-maven-plugin + + + maven-failsafe-plugin + 3.2.5 + + + + integration-test + verify + + + + + + + org.jacoco + jacoco-maven-plugin + 0.8.11 + + + + + + prepare-agent + + prepare-agent + + + + + + report + verify + + report + + + + + + **/dto/** + **/config/** + **/exception/** + **/*Application.class + + + + + + + check + verify + + check + + + + + BUNDLE + + + LINE + COVEREDRATIO + 0.80 + + + + + + + + + diff --git a/src/main/java/com/tpximpact/urlshortener/controller/UrlController.java b/src/main/java/com/tpximpact/urlshortener/controller/UrlController.java index a46cb26..f8f1f28 100644 --- a/src/main/java/com/tpximpact/urlshortener/controller/UrlController.java +++ b/src/main/java/com/tpximpact/urlshortener/controller/UrlController.java @@ -8,6 +8,7 @@ import lombok.RequiredArgsConstructor; import lombok.extern.slf4j.Slf4j; import org.springframework.http.ResponseEntity; +import org.springframework.web.bind.annotation.CrossOrigin; import org.springframework.web.bind.annotation.DeleteMapping; import org.springframework.web.bind.annotation.GetMapping; import org.springframework.web.bind.annotation.PathVariable; @@ -17,6 +18,7 @@ import java.net.URI; import java.util.List; +@CrossOrigin(origins = "http://localhost:5173") @RestController @RequiredArgsConstructor @Slf4j diff --git a/src/main/java/com/tpximpact/urlshortener/service/UrlServiceImpl.java b/src/main/java/com/tpximpact/urlshortener/service/UrlServiceImpl.java index c9efd81..febaf01 100644 --- a/src/main/java/com/tpximpact/urlshortener/service/UrlServiceImpl.java +++ b/src/main/java/com/tpximpact/urlshortener/service/UrlServiceImpl.java @@ -24,18 +24,13 @@ public class UrlServiceImpl implements UrlService { @Override public UrlResponse shorten(UrlRequest request) { - String alias = request.customAlias() != null - ? request.customAlias() : UrlUtils.generateAlias(); + var alias = getAlias(request); if (urlRepository.existsByAlias(alias)) { throw new BadRequestException("Invalid input or alias already taken"); } - Url url = Url - .builder() - .fullUrl(request.fullUrl()) - .alias(alias) - .build(); + var url = getUrl(request, alias); urlRepository.save(url); @@ -63,9 +58,22 @@ public List getAll() { public void delete(String alias) { - Url url = urlRepository.findByAlias(alias) + var url = urlRepository.findByAlias(alias) .orElseThrow(() -> new NotFoundException("Alias not found")); log.info("Deleting shorten url for alias '{}' from the DB", url.getAlias()); urlRepository.delete(url); } + + private Url getUrl(UrlRequest request, String alias) { + return Url + .builder() + .fullUrl(request.fullUrl()) + .alias(alias) + .build(); + } + + private String getAlias(UrlRequest request) { + return request.customAlias() != null + ? request.customAlias() : UrlUtils.generateAlias(); + } } diff --git a/src/main/resources/application-dev.yaml b/src/main/resources/application-dev.yaml index 4ea6c30..387aad3 100644 --- a/src/main/resources/application-dev.yaml +++ b/src/main/resources/application-dev.yaml @@ -1,16 +1,27 @@ spring: datasource: - url: jdbc:h2:file:./data/url-shorten-db;AUTO_SERVER=TRUE;DB_CLOSE_ON_EXIT=FALSE + # Use 'file:' prefix. The path can be absolute or relative (./data/url_db) + url: jdbc:h2:file:./data/shortener_db;DB_CLOSE_DELAY=-1;AUTO_SERVER=TRUE driver-class-name: org.h2.Driver username: sa - password: + password: password + hikari: + pool-name: URL-Shortener-Pool + maximum-pool-size: 10 + minimum-idle: 5 + idle-timeout: 30000 + max-lifetime: 1800000 + connection-timeout: 20000 + + # Enable H2 Console to view your files in the browser h2: console: enabled: true path: /h2-console + # JPA / Hibernate Settings jpa: - show_sql: true hibernate: - ddl-auto: update + ddl-auto: update # Automatically creates tables based on your Entities + show-sql: true \ No newline at end of file diff --git a/src/test/java/com/tpximpact/urlshortener/controller/UrlControllerIntegrationTest.java b/src/test/java/com/tpximpact/urlshortener/controller/UrlControllerIT.java similarity index 96% rename from src/test/java/com/tpximpact/urlshortener/controller/UrlControllerIntegrationTest.java rename to src/test/java/com/tpximpact/urlshortener/controller/UrlControllerIT.java index a2d7cbb..9460155 100644 --- a/src/test/java/com/tpximpact/urlshortener/controller/UrlControllerIntegrationTest.java +++ b/src/test/java/com/tpximpact/urlshortener/controller/UrlControllerIT.java @@ -8,6 +8,7 @@ import org.springframework.boot.test.autoconfigure.web.servlet.AutoConfigureMockMvc; import org.springframework.boot.test.context.SpringBootTest; import org.springframework.http.MediaType; +import org.springframework.test.context.ActiveProfiles; import org.springframework.test.web.servlet.MockMvc; import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.delete; @@ -20,7 +21,8 @@ @SpringBootTest @AutoConfigureMockMvc -class UrlControllerIntegrationTest { +@ActiveProfiles("test") +class UrlControllerIT { @Autowired private MockMvc mockMvc;