├── src ├── main │ ├── resources │ │ └── application.properties │ └── java │ │ └── com │ │ └── example │ │ └── testtaskrestapi │ │ ├── services │ │ ├── FrequencyService.java │ │ └── impls │ │ │ └── FrequencyServiceImpl.java │ │ ├── TestTaskRestApiApplication.java │ │ ├── exceptions │ │ ├── ClientRequestException.java │ │ └── handlers │ │ │ └── GlobalExceptionHandler.java │ │ └── controllers │ │ └── FrequencyController.java └── test │ └── java │ └── com │ └── example │ └── testtaskrestapi │ ├── FrequencyServiceTest.java │ └── FrequencyControllerTest.java ├── .mvn └── wrapper │ ├── maven-wrapper.jar │ └── maven-wrapper.properties ├── .gitignore ├── pom.xml ├── README.md ├── mvnw.cmd └── mvnw /src/main/resources/application.properties: -------------------------------------------------------------------------------- 1 | server.port=8088 2 | 3 | -------------------------------------------------------------------------------- /.mvn/wrapper/maven-wrapper.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Recwayer/TestTaskRestAPI/HEAD/.mvn/wrapper/maven-wrapper.jar -------------------------------------------------------------------------------- /src/main/java/com/example/testtaskrestapi/services/FrequencyService.java: -------------------------------------------------------------------------------- 1 | package com.example.testtaskrestapi.services; 2 | 3 | import java.util.Map; 4 | 5 | public interface FrequencyService { 6 | Map getFrequencyChar(String input); 7 | } 8 | -------------------------------------------------------------------------------- /.mvn/wrapper/maven-wrapper.properties: -------------------------------------------------------------------------------- 1 | distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.9.5/apache-maven-3.9.5-bin.zip 2 | wrapperUrl=https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.2.0/maven-wrapper-3.2.0.jar 3 | -------------------------------------------------------------------------------- /src/main/java/com/example/testtaskrestapi/TestTaskRestApiApplication.java: -------------------------------------------------------------------------------- 1 | package com.example.testtaskrestapi; 2 | 3 | import org.springframework.boot.SpringApplication; 4 | import org.springframework.boot.autoconfigure.SpringBootApplication; 5 | 6 | @SpringBootApplication 7 | public class TestTaskRestApiApplication { 8 | 9 | public static void main(String[] args) { 10 | SpringApplication.run(TestTaskRestApiApplication.class, args); 11 | } 12 | 13 | } 14 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | HELP.md 2 | target/ 3 | !.mvn/wrapper/maven-wrapper.jar 4 | !**/src/main/**/target/ 5 | !**/src/test/**/target/ 6 | 7 | ### STS ### 8 | .apt_generated 9 | .classpath 10 | .factorypath 11 | .project 12 | .settings 13 | .springBeans 14 | .sts4-cache 15 | 16 | ### IntelliJ IDEA ### 17 | .idea 18 | *.iws 19 | *.iml 20 | *.ipr 21 | 22 | ### NetBeans ### 23 | /nbproject/private/ 24 | /nbbuild/ 25 | /dist/ 26 | /nbdist/ 27 | /.nb-gradle/ 28 | build/ 29 | !**/src/main/**/build/ 30 | !**/src/test/**/build/ 31 | 32 | ### VS Code ### 33 | .vscode/ 34 | -------------------------------------------------------------------------------- /src/main/java/com/example/testtaskrestapi/exceptions/ClientRequestException.java: -------------------------------------------------------------------------------- 1 | package com.example.testtaskrestapi.exceptions; 2 | 3 | public abstract class ClientRequestException extends RuntimeException { 4 | public ClientRequestException(String message) { 5 | super(message); 6 | } 7 | 8 | public ClientRequestException(Throwable cause) { 9 | super(cause); 10 | } 11 | 12 | public static class InputException extends ClientRequestException { 13 | public InputException(Throwable cause) { 14 | super(cause); 15 | } 16 | 17 | public InputException(String message) { 18 | super(message); 19 | } 20 | } 21 | } 22 | -------------------------------------------------------------------------------- /src/main/java/com/example/testtaskrestapi/exceptions/handlers/GlobalExceptionHandler.java: -------------------------------------------------------------------------------- 1 | package com.example.testtaskrestapi.exceptions.handlers; 2 | 3 | import com.example.testtaskrestapi.exceptions.ClientRequestException; 4 | import org.springframework.http.ResponseEntity; 5 | import org.springframework.web.bind.annotation.ControllerAdvice; 6 | import org.springframework.web.bind.annotation.ExceptionHandler; 7 | 8 | @ControllerAdvice 9 | public class GlobalExceptionHandler { 10 | @ExceptionHandler(ClientRequestException.InputException.class) 11 | public ResponseEntity handleInputException(ClientRequestException.InputException ex) { 12 | return ResponseEntity.badRequest().body(ex.getMessage()); 13 | } 14 | } 15 | -------------------------------------------------------------------------------- /src/main/java/com/example/testtaskrestapi/services/impls/FrequencyServiceImpl.java: -------------------------------------------------------------------------------- 1 | package com.example.testtaskrestapi.services.impls; 2 | 3 | import com.example.testtaskrestapi.services.FrequencyService; 4 | import org.springframework.stereotype.Service; 5 | 6 | import java.util.Comparator; 7 | import java.util.HashMap; 8 | import java.util.LinkedHashMap; 9 | import java.util.Map; 10 | import java.util.stream.Collectors; 11 | 12 | @Service 13 | public class FrequencyServiceImpl implements FrequencyService { 14 | public Map getFrequencyChar(String input) { 15 | if(input==null||input.isEmpty()){ 16 | throw new IllegalArgumentException("Input cannot be empty."); 17 | } 18 | Map map = new HashMap<>(); 19 | 20 | for (String s : input.split("")) { 21 | char c = s.charAt(0); 22 | map.put(c, map.getOrDefault(c, 0) + 1); 23 | } 24 | return map.entrySet().stream().sorted(Map.Entry.comparingByValue(Comparator.reverseOrder())).collect(Collectors.toMap(Map.Entry::getKey, Map.Entry::getValue, (e1, e2) -> e1, LinkedHashMap::new)); 25 | } 26 | } 27 | -------------------------------------------------------------------------------- /src/test/java/com/example/testtaskrestapi/FrequencyServiceTest.java: -------------------------------------------------------------------------------- 1 | package com.example.testtaskrestapi; 2 | 3 | import com.example.testtaskrestapi.services.FrequencyService; 4 | import com.example.testtaskrestapi.services.impls.FrequencyServiceImpl; 5 | import org.junit.Before; 6 | import org.junit.Test; 7 | 8 | import java.util.LinkedHashMap; 9 | import java.util.Map; 10 | 11 | import static org.junit.Assert.assertEquals; 12 | import static org.junit.Assert.assertThrows; 13 | 14 | public class FrequencyServiceTest { 15 | private FrequencyService service; 16 | private Map expectedMap; 17 | 18 | @Before 19 | public void init() { 20 | service = new FrequencyServiceImpl(); 21 | expectedMap = new LinkedHashMap<>(); 22 | } 23 | 24 | @Test 25 | public void testGetFrequencyChar() { 26 | expectedMap.put('a', 5); 27 | expectedMap.put('c', 4); 28 | expectedMap.put('b', 1); 29 | expectedMap.put('\\', 1); 30 | 31 | assertEquals(expectedMap, service.getFrequencyChar("aaaaabcccc\\")); 32 | } 33 | 34 | @Test 35 | public void testGetFrequencyCharEmptyString() { 36 | assertThrows(IllegalArgumentException.class, () -> service.getFrequencyChar("")); 37 | } 38 | 39 | @Test 40 | public void testGetFrequencyCharNullInput() { 41 | assertThrows(IllegalArgumentException.class, () -> service.getFrequencyChar(null)); 42 | 43 | } 44 | } 45 | -------------------------------------------------------------------------------- /src/main/java/com/example/testtaskrestapi/controllers/FrequencyController.java: -------------------------------------------------------------------------------- 1 | package com.example.testtaskrestapi.controllers; 2 | 3 | import com.example.testtaskrestapi.exceptions.ClientRequestException; 4 | import com.example.testtaskrestapi.services.FrequencyService; 5 | import org.springframework.beans.factory.annotation.Autowired; 6 | import org.springframework.web.bind.annotation.PostMapping; 7 | import org.springframework.web.bind.annotation.RequestBody; 8 | import org.springframework.web.bind.annotation.RestController; 9 | 10 | import java.util.Map; 11 | 12 | @RestController 13 | public class FrequencyController { 14 | private final FrequencyService frequencyService; 15 | @Autowired 16 | public FrequencyController(FrequencyService frequencyService) { 17 | this.frequencyService = frequencyService; 18 | } 19 | 20 | 21 | 22 | @PostMapping("/calculateFrequency") 23 | public Map calculateFrequency(@RequestBody String input) { 24 | if (input == null || input.isEmpty()) { 25 | throw new ClientRequestException.InputException("Input cannot be empty."); 26 | } else if(input.length()>10000){ 27 | throw new ClientRequestException.InputException(String.format("Input must not exceed 10000 characters. Current line length: %d.",input.length())); 28 | } else if(input.contains("\n") || input.contains("\r")){ 29 | throw new ClientRequestException.InputException("Input cannot be divided into several lines."); 30 | } 31 | return frequencyService.getFrequencyChar(input); 32 | } 33 | } 34 | -------------------------------------------------------------------------------- /pom.xml: -------------------------------------------------------------------------------- 1 | 2 | 4 | 4.0.0 5 | 6 | org.springframework.boot 7 | spring-boot-starter-parent 8 | 3.1.5 9 | 10 | 11 | com.example 12 | TestTaskRestAPI 13 | 0.0.1-SNAPSHOT 14 | TestTaskRestAPI 15 | TestTaskRestAPI 16 | 17 | 17 18 | 19 | 20 | 21 | org.springframework.boot 22 | spring-boot-starter-web 23 | 24 | 25 | org.mockito 26 | mockito-junit-jupiter 27 | 5.7.0 28 | test 29 | 30 | 31 | junit 32 | junit 33 | 4.13.2 34 | test 35 | 36 | 37 | 38 | 39 | 40 | 41 | org.springframework.boot 42 | spring-boot-maven-plugin 43 | 44 | 45 | 46 | 47 | 48 | -------------------------------------------------------------------------------- /src/test/java/com/example/testtaskrestapi/FrequencyControllerTest.java: -------------------------------------------------------------------------------- 1 | package com.example.testtaskrestapi; 2 | 3 | import com.example.testtaskrestapi.controllers.FrequencyController; 4 | import com.example.testtaskrestapi.exceptions.ClientRequestException; 5 | import com.example.testtaskrestapi.services.FrequencyService; 6 | import org.junit.Before; 7 | import org.junit.Test; 8 | import org.mockito.Mockito; 9 | 10 | import java.util.LinkedHashMap; 11 | import java.util.Map; 12 | 13 | import static org.junit.Assert.assertEquals; 14 | import static org.junit.Assert.assertThrows; 15 | import static org.mockito.Mockito.when; 16 | 17 | public class FrequencyControllerTest { 18 | private FrequencyService service; 19 | private FrequencyController controller; 20 | 21 | @Before 22 | public void init() { 23 | service = Mockito.mock(FrequencyService.class); 24 | controller = new FrequencyController(service); 25 | } 26 | 27 | @Test 28 | public void testCalculateFrequency() { 29 | String input = "aaaaabcccc\\"; 30 | Map expectedMap = new LinkedHashMap<>(); 31 | expectedMap.put('a', 5); 32 | expectedMap.put('c', 4); 33 | expectedMap.put('b', 1); 34 | expectedMap.put('\\', 1); 35 | when(service.getFrequencyChar(input)).thenReturn(expectedMap); 36 | 37 | Map result = controller.calculateFrequency(input); 38 | 39 | assertEquals(expectedMap, result); 40 | } 41 | 42 | @Test 43 | public void testCalculateFrequencyEmptyInput() { 44 | String input = ""; 45 | assertThrows(ClientRequestException.InputException.class,()->controller.calculateFrequency(input)); 46 | try { 47 | controller.calculateFrequency(input); 48 | } catch (ClientRequestException.InputException e) { 49 | assertEquals("Input cannot be empty.", e.getMessage()); 50 | } 51 | } 52 | 53 | @Test 54 | public void testCalculateFrequencyLongInput() { 55 | String input = "a".repeat(10001); 56 | assertThrows(ClientRequestException.InputException.class,()->controller.calculateFrequency(input)); 57 | try { 58 | controller.calculateFrequency(input); 59 | } catch (ClientRequestException.InputException e) { 60 | assertEquals("Input must not exceed 10000 characters. Current line length: 10001.", e.getMessage()); 61 | } 62 | } 63 | @Test 64 | public void testCalculateFrequencyMultipleLinesInput() { 65 | String input = "aaa\nbbb"; 66 | assertThrows(ClientRequestException.InputException.class,()->controller.calculateFrequency(input)); 67 | try { 68 | controller.calculateFrequency(input); 69 | } catch (ClientRequestException.InputException e) { 70 | assertEquals("Input cannot be divided into several lines.", e.getMessage()); 71 | } 72 | } 73 | } 74 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Тестовое задание. 2 | 3 | Спроектировать(продумать формат и ограничения входящих/исходящих параметров) и реализовать REST API, вычисляющее частоту встречи символов по заданной строке. Результат должен быть отсортирован по убыванию количества вхождений символа в заданную строку. 4 | 5 | Требования к решению: 6 | 1. [x] Java 8+ 7 | 2. [x] Spring boot 2+ 8 | 3. [x] Решение должно быть покрыто тестами 9 | 4. [x] У решения должна быть документация по запуску и формату входящих/исходящих параметров 10 | 5. [x] Код решения необходимо разместить в публичном Github репозитории. 11 | 12 | # Документация по запуску 13 | 14 | ## Документация по запуску через командную строку 15 | 16 | ### Требования к окружению 17 | - Java 8 или выше 18 | - Maven (для сборки проекта) 19 | 20 | ### Инструкции по установке 21 | 1. Склонируйте репозиторий: **`git clone https://github.com/Recwayer/TestTaskRestAPI`** 22 | 2. Перейдите в каталог проекта: **`cd TestTaskRestAPI`** 23 | 3. Соберите приложение: **`mvn clean install`** 24 | 25 | ### Сборка и запуск 26 | - Соберите и запустите приложение: **`java -jar target/testtaskrestapi-1.0.jar`** 27 | 28 | ### Пример запроса 29 | - Для отправки запроса к API, используйте HTTP-клиент, такой как Postman 30 | - Запрос POST: **`POST localhost:8088/calculateFrequency`** 31 | ![image](https://github.com/Recwayer/TestTaskRestAPI/assets/95271934/4824ce9e-151a-4818-bdbd-f0902cd5ff7e) 32 | 33 | 34 | 35 | ## Документация по запуску в IntelliJ IDEA 36 | 37 | ### Требования к окружению 38 | - Java 8 или выше 39 | - IntelliJ IDEA (последняя версия) 40 | 41 | ### Инструкции по установке 42 | 1. Клонирование репозитория: 43 | - Откройте IntelliJ IDEA. 44 | - Нажмите **`Get from Version Control`** (Получить из контроля версий) на экране приветствия или перейдите в меню **`File`** (Файл) > **`New`** (Новый) > **`Project from Version Control`** (Проект из системы контроля версий). 45 | - Введите URL репозитория: **`https://github.com/Recwayer/TestTaskRestAPI`** 46 | - Укажите путь к каталогу, где вы хотите сохранить проект, и нажмите **`Clone`** 47 | 2. Открытие проекта: 48 | - После завершения клонирования, IntelliJ IDEA автоматически откроет проект. 49 | 3. Импорт проекта: 50 | - IntelliJ IDEA автоматически обнаружит, что это проект Maven. Если необходимо, подтвердите импорт и настройку проекта. 51 | 52 | ### Запуск приложения 53 | 1. Найдите класс **`TestTaskRestApiApplication`**: 54 | - Откройте структуру проекта в IntelliJ IDEA (обычно находится в левой части окна). 55 | - Раскройте каталог "src" > "main" > "java". 56 | - Найдите класс **`TestTaskRestApiApplication`**. 57 | 2. Запустите приложение: 58 | - Щелкните правой кнопкой мыши по классу с методом **`main`** . 59 | - Выберите **`Run`** (Запустить) из контекстного меню. 60 | 3. Ожидайте запуска: 61 | - Подождите, пока приложение успешно запустится. Вы увидите логи в консоли IntelliJ IDEA. 62 | 4. Тестируйте API: 63 | - После успешного запуска приложения, вы можете протестировать API, отправляя запросы с помощью HTTP-клиента, такого как Postman. 64 | 65 | 66 | 67 | 68 | # REST API для вычисления частоты встречи символов 69 | Это REST API позволяет вычислить частоту встречи символов в заданной строке. Результат сортируется в порядке убывания количества вхождений символов в строку. 70 | 71 | ## Эндпоинты API 72 | **`/calculateFrequency`** 73 | * Метод: POST 74 | * Описание: Вычисляет частоту встречи символов в заданной строке. 75 | * Входящие параметры: 76 | * input (строка): Строка для анализа частоты символов. 77 | * Исходящие параметры: 78 | * JSON-объект с частотой символов. 79 | * Возможные ошибки: 80 | * 400 Bad Request: Если строка пуста, содержит более 10 000 символов или содержит символы новой строки (\n) или возврата каретки (\r). 81 | 82 | ## Формат входящих параметров 83 | * input (строка): Строка, для которой нужно вычислить частоту встречи символов. 84 | * Допустимая длина строки: от 1 до 10 000 символов. 85 | > [!NOTE] 86 | > ![image](https://github.com/Recwayer/TestTaskRestAPI/assets/95271934/cf2e4cb0-d360-49cc-af6b-29f9b3f9ef80) 87 | * Запрос должен состоять из одной строки. 88 | > [!NOTE] 89 | > ![image](https://github.com/Recwayer/TestTaskRestAPI/assets/95271934/1a4c0a5a-7600-426e-941d-cfab5589b8bb) 90 | 91 | ## Формат исходящих параметров 92 | * JSON-объект, содержащий символы и их частоту встречи в строке. Результат отсортирован по убыванию частоты вхождений. 93 | > [!Warning] 94 | > Если использовать специальные символы Java - '\ ','" ' и т.д., то символы будут содержать дополнительно '\ '. 95 | > ![image](https://github.com/Recwayer/TestTaskRestAPI/assets/95271934/116ffb52-74a1-4aa6-ab23-3d9e1753bc0f) 96 | > ![image](https://github.com/Recwayer/TestTaskRestAPI/assets/95271934/77e51c7a-1828-4222-9675-496d9280a28b) 97 | -------------------------------------------------------------------------------- /mvnw.cmd: -------------------------------------------------------------------------------- 1 | @REM ---------------------------------------------------------------------------- 2 | @REM Licensed to the Apache Software Foundation (ASF) under one 3 | @REM or more contributor license agreements. See the NOTICE file 4 | @REM distributed with this work for additional information 5 | @REM regarding copyright ownership. The ASF licenses this file 6 | @REM to you under the Apache License, Version 2.0 (the 7 | @REM "License"); you may not use this file except in compliance 8 | @REM with the License. You may obtain a copy of the License at 9 | @REM 10 | @REM https://www.apache.org/licenses/LICENSE-2.0 11 | @REM 12 | @REM Unless required by applicable law or agreed to in writing, 13 | @REM software distributed under the License is distributed on an 14 | @REM "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 15 | @REM KIND, either express or implied. See the License for the 16 | @REM specific language governing permissions and limitations 17 | @REM under the License. 18 | @REM ---------------------------------------------------------------------------- 19 | 20 | @REM ---------------------------------------------------------------------------- 21 | @REM Apache Maven Wrapper startup batch script, version 3.2.0 22 | @REM 23 | @REM Required ENV vars: 24 | @REM JAVA_HOME - location of a JDK home dir 25 | @REM 26 | @REM Optional ENV vars 27 | @REM MAVEN_BATCH_ECHO - set to 'on' to enable the echoing of the batch commands 28 | @REM MAVEN_BATCH_PAUSE - set to 'on' to wait for a keystroke before ending 29 | @REM MAVEN_OPTS - parameters passed to the Java VM when running Maven 30 | @REM e.g. to debug Maven itself, use 31 | @REM set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000 32 | @REM MAVEN_SKIP_RC - flag to disable loading of mavenrc files 33 | @REM ---------------------------------------------------------------------------- 34 | 35 | @REM Begin all REM lines with '@' in case MAVEN_BATCH_ECHO is 'on' 36 | @echo off 37 | @REM set title of command window 38 | title %0 39 | @REM enable echoing by setting MAVEN_BATCH_ECHO to 'on' 40 | @if "%MAVEN_BATCH_ECHO%" == "on" echo %MAVEN_BATCH_ECHO% 41 | 42 | @REM set %HOME% to equivalent of $HOME 43 | if "%HOME%" == "" (set "HOME=%HOMEDRIVE%%HOMEPATH%") 44 | 45 | @REM Execute a user defined script before this one 46 | if not "%MAVEN_SKIP_RC%" == "" goto skipRcPre 47 | @REM check for pre script, once with legacy .bat ending and once with .cmd ending 48 | if exist "%USERPROFILE%\mavenrc_pre.bat" call "%USERPROFILE%\mavenrc_pre.bat" %* 49 | if exist "%USERPROFILE%\mavenrc_pre.cmd" call "%USERPROFILE%\mavenrc_pre.cmd" %* 50 | :skipRcPre 51 | 52 | @setlocal 53 | 54 | set ERROR_CODE=0 55 | 56 | @REM To isolate internal variables from possible post scripts, we use another setlocal 57 | @setlocal 58 | 59 | @REM ==== START VALIDATION ==== 60 | if not "%JAVA_HOME%" == "" goto OkJHome 61 | 62 | echo. 63 | echo Error: JAVA_HOME not found in your environment. >&2 64 | echo Please set the JAVA_HOME variable in your environment to match the >&2 65 | echo location of your Java installation. >&2 66 | echo. 67 | goto error 68 | 69 | :OkJHome 70 | if exist "%JAVA_HOME%\bin\java.exe" goto init 71 | 72 | echo. 73 | echo Error: JAVA_HOME is set to an invalid directory. >&2 74 | echo JAVA_HOME = "%JAVA_HOME%" >&2 75 | echo Please set the JAVA_HOME variable in your environment to match the >&2 76 | echo location of your Java installation. >&2 77 | echo. 78 | goto error 79 | 80 | @REM ==== END VALIDATION ==== 81 | 82 | :init 83 | 84 | @REM Find the project base dir, i.e. the directory that contains the folder ".mvn". 85 | @REM Fallback to current working directory if not found. 86 | 87 | set MAVEN_PROJECTBASEDIR=%MAVEN_BASEDIR% 88 | IF NOT "%MAVEN_PROJECTBASEDIR%"=="" goto endDetectBaseDir 89 | 90 | set EXEC_DIR=%CD% 91 | set WDIR=%EXEC_DIR% 92 | :findBaseDir 93 | IF EXIST "%WDIR%"\.mvn goto baseDirFound 94 | cd .. 95 | IF "%WDIR%"=="%CD%" goto baseDirNotFound 96 | set WDIR=%CD% 97 | goto findBaseDir 98 | 99 | :baseDirFound 100 | set MAVEN_PROJECTBASEDIR=%WDIR% 101 | cd "%EXEC_DIR%" 102 | goto endDetectBaseDir 103 | 104 | :baseDirNotFound 105 | set MAVEN_PROJECTBASEDIR=%EXEC_DIR% 106 | cd "%EXEC_DIR%" 107 | 108 | :endDetectBaseDir 109 | 110 | IF NOT EXIST "%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config" goto endReadAdditionalConfig 111 | 112 | @setlocal EnableExtensions EnableDelayedExpansion 113 | for /F "usebackq delims=" %%a in ("%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config") do set JVM_CONFIG_MAVEN_PROPS=!JVM_CONFIG_MAVEN_PROPS! %%a 114 | @endlocal & set JVM_CONFIG_MAVEN_PROPS=%JVM_CONFIG_MAVEN_PROPS% 115 | 116 | :endReadAdditionalConfig 117 | 118 | SET MAVEN_JAVA_EXE="%JAVA_HOME%\bin\java.exe" 119 | set WRAPPER_JAR="%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.jar" 120 | set WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain 121 | 122 | set WRAPPER_URL="https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.2.0/maven-wrapper-3.2.0.jar" 123 | 124 | FOR /F "usebackq tokens=1,2 delims==" %%A IN ("%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.properties") DO ( 125 | IF "%%A"=="wrapperUrl" SET WRAPPER_URL=%%B 126 | ) 127 | 128 | @REM Extension to allow automatically downloading the maven-wrapper.jar from Maven-central 129 | @REM This allows using the maven wrapper in projects that prohibit checking in binary data. 130 | if exist %WRAPPER_JAR% ( 131 | if "%MVNW_VERBOSE%" == "true" ( 132 | echo Found %WRAPPER_JAR% 133 | ) 134 | ) else ( 135 | if not "%MVNW_REPOURL%" == "" ( 136 | SET WRAPPER_URL="%MVNW_REPOURL%/org/apache/maven/wrapper/maven-wrapper/3.2.0/maven-wrapper-3.2.0.jar" 137 | ) 138 | if "%MVNW_VERBOSE%" == "true" ( 139 | echo Couldn't find %WRAPPER_JAR%, downloading it ... 140 | echo Downloading from: %WRAPPER_URL% 141 | ) 142 | 143 | powershell -Command "&{"^ 144 | "$webclient = new-object System.Net.WebClient;"^ 145 | "if (-not ([string]::IsNullOrEmpty('%MVNW_USERNAME%') -and [string]::IsNullOrEmpty('%MVNW_PASSWORD%'))) {"^ 146 | "$webclient.Credentials = new-object System.Net.NetworkCredential('%MVNW_USERNAME%', '%MVNW_PASSWORD%');"^ 147 | "}"^ 148 | "[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12; $webclient.DownloadFile('%WRAPPER_URL%', '%WRAPPER_JAR%')"^ 149 | "}" 150 | if "%MVNW_VERBOSE%" == "true" ( 151 | echo Finished downloading %WRAPPER_JAR% 152 | ) 153 | ) 154 | @REM End of extension 155 | 156 | @REM If specified, validate the SHA-256 sum of the Maven wrapper jar file 157 | SET WRAPPER_SHA_256_SUM="" 158 | FOR /F "usebackq tokens=1,2 delims==" %%A IN ("%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.properties") DO ( 159 | IF "%%A"=="wrapperSha256Sum" SET WRAPPER_SHA_256_SUM=%%B 160 | ) 161 | IF NOT %WRAPPER_SHA_256_SUM%=="" ( 162 | powershell -Command "&{"^ 163 | "$hash = (Get-FileHash \"%WRAPPER_JAR%\" -Algorithm SHA256).Hash.ToLower();"^ 164 | "If('%WRAPPER_SHA_256_SUM%' -ne $hash){"^ 165 | " Write-Output 'Error: Failed to validate Maven wrapper SHA-256, your Maven wrapper might be compromised.';"^ 166 | " Write-Output 'Investigate or delete %WRAPPER_JAR% to attempt a clean download.';"^ 167 | " Write-Output 'If you updated your Maven version, you need to update the specified wrapperSha256Sum property.';"^ 168 | " exit 1;"^ 169 | "}"^ 170 | "}" 171 | if ERRORLEVEL 1 goto error 172 | ) 173 | 174 | @REM Provide a "standardized" way to retrieve the CLI args that will 175 | @REM work with both Windows and non-Windows executions. 176 | set MAVEN_CMD_LINE_ARGS=%* 177 | 178 | %MAVEN_JAVA_EXE% ^ 179 | %JVM_CONFIG_MAVEN_PROPS% ^ 180 | %MAVEN_OPTS% ^ 181 | %MAVEN_DEBUG_OPTS% ^ 182 | -classpath %WRAPPER_JAR% ^ 183 | "-Dmaven.multiModuleProjectDirectory=%MAVEN_PROJECTBASEDIR%" ^ 184 | %WRAPPER_LAUNCHER% %MAVEN_CONFIG% %* 185 | if ERRORLEVEL 1 goto error 186 | goto end 187 | 188 | :error 189 | set ERROR_CODE=1 190 | 191 | :end 192 | @endlocal & set ERROR_CODE=%ERROR_CODE% 193 | 194 | if not "%MAVEN_SKIP_RC%"=="" goto skipRcPost 195 | @REM check for post script, once with legacy .bat ending and once with .cmd ending 196 | if exist "%USERPROFILE%\mavenrc_post.bat" call "%USERPROFILE%\mavenrc_post.bat" 197 | if exist "%USERPROFILE%\mavenrc_post.cmd" call "%USERPROFILE%\mavenrc_post.cmd" 198 | :skipRcPost 199 | 200 | @REM pause the script if MAVEN_BATCH_PAUSE is set to 'on' 201 | if "%MAVEN_BATCH_PAUSE%"=="on" pause 202 | 203 | if "%MAVEN_TERMINATE_CMD%"=="on" exit %ERROR_CODE% 204 | 205 | cmd /C exit /B %ERROR_CODE% 206 | -------------------------------------------------------------------------------- /mvnw: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | # ---------------------------------------------------------------------------- 3 | # Licensed to the Apache Software Foundation (ASF) under one 4 | # or more contributor license agreements. See the NOTICE file 5 | # distributed with this work for additional information 6 | # regarding copyright ownership. The ASF licenses this file 7 | # to you under the Apache License, Version 2.0 (the 8 | # "License"); you may not use this file except in compliance 9 | # with the License. You may obtain a copy of the License at 10 | # 11 | # https://www.apache.org/licenses/LICENSE-2.0 12 | # 13 | # Unless required by applicable law or agreed to in writing, 14 | # software distributed under the License is distributed on an 15 | # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16 | # KIND, either express or implied. See the License for the 17 | # specific language governing permissions and limitations 18 | # under the License. 19 | # ---------------------------------------------------------------------------- 20 | 21 | # ---------------------------------------------------------------------------- 22 | # Apache Maven Wrapper startup batch script, version 3.2.0 23 | # 24 | # Required ENV vars: 25 | # ------------------ 26 | # JAVA_HOME - location of a JDK home dir 27 | # 28 | # Optional ENV vars 29 | # ----------------- 30 | # MAVEN_OPTS - parameters passed to the Java VM when running Maven 31 | # e.g. to debug Maven itself, use 32 | # set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000 33 | # MAVEN_SKIP_RC - flag to disable loading of mavenrc files 34 | # ---------------------------------------------------------------------------- 35 | 36 | if [ -z "$MAVEN_SKIP_RC" ] ; then 37 | 38 | if [ -f /usr/local/etc/mavenrc ] ; then 39 | . /usr/local/etc/mavenrc 40 | fi 41 | 42 | if [ -f /etc/mavenrc ] ; then 43 | . /etc/mavenrc 44 | fi 45 | 46 | if [ -f "$HOME/.mavenrc" ] ; then 47 | . "$HOME/.mavenrc" 48 | fi 49 | 50 | fi 51 | 52 | # OS specific support. $var _must_ be set to either true or false. 53 | cygwin=false; 54 | darwin=false; 55 | mingw=false 56 | case "$(uname)" in 57 | CYGWIN*) cygwin=true ;; 58 | MINGW*) mingw=true;; 59 | Darwin*) darwin=true 60 | # Use /usr/libexec/java_home if available, otherwise fall back to /Library/Java/Home 61 | # See https://developer.apple.com/library/mac/qa/qa1170/_index.html 62 | if [ -z "$JAVA_HOME" ]; then 63 | if [ -x "/usr/libexec/java_home" ]; then 64 | JAVA_HOME="$(/usr/libexec/java_home)"; export JAVA_HOME 65 | else 66 | JAVA_HOME="/Library/Java/Home"; export JAVA_HOME 67 | fi 68 | fi 69 | ;; 70 | esac 71 | 72 | if [ -z "$JAVA_HOME" ] ; then 73 | if [ -r /etc/gentoo-release ] ; then 74 | JAVA_HOME=$(java-config --jre-home) 75 | fi 76 | fi 77 | 78 | # For Cygwin, ensure paths are in UNIX format before anything is touched 79 | if $cygwin ; then 80 | [ -n "$JAVA_HOME" ] && 81 | JAVA_HOME=$(cygpath --unix "$JAVA_HOME") 82 | [ -n "$CLASSPATH" ] && 83 | CLASSPATH=$(cygpath --path --unix "$CLASSPATH") 84 | fi 85 | 86 | # For Mingw, ensure paths are in UNIX format before anything is touched 87 | if $mingw ; then 88 | [ -n "$JAVA_HOME" ] && [ -d "$JAVA_HOME" ] && 89 | JAVA_HOME="$(cd "$JAVA_HOME" || (echo "cannot cd into $JAVA_HOME."; exit 1); pwd)" 90 | fi 91 | 92 | if [ -z "$JAVA_HOME" ]; then 93 | javaExecutable="$(which javac)" 94 | if [ -n "$javaExecutable" ] && ! [ "$(expr "\"$javaExecutable\"" : '\([^ ]*\)')" = "no" ]; then 95 | # readlink(1) is not available as standard on Solaris 10. 96 | readLink=$(which readlink) 97 | if [ ! "$(expr "$readLink" : '\([^ ]*\)')" = "no" ]; then 98 | if $darwin ; then 99 | javaHome="$(dirname "\"$javaExecutable\"")" 100 | javaExecutable="$(cd "\"$javaHome\"" && pwd -P)/javac" 101 | else 102 | javaExecutable="$(readlink -f "\"$javaExecutable\"")" 103 | fi 104 | javaHome="$(dirname "\"$javaExecutable\"")" 105 | javaHome=$(expr "$javaHome" : '\(.*\)/bin') 106 | JAVA_HOME="$javaHome" 107 | export JAVA_HOME 108 | fi 109 | fi 110 | fi 111 | 112 | if [ -z "$JAVACMD" ] ; then 113 | if [ -n "$JAVA_HOME" ] ; then 114 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then 115 | # IBM's JDK on AIX uses strange locations for the executables 116 | JAVACMD="$JAVA_HOME/jre/sh/java" 117 | else 118 | JAVACMD="$JAVA_HOME/bin/java" 119 | fi 120 | else 121 | JAVACMD="$(\unset -f command 2>/dev/null; \command -v java)" 122 | fi 123 | fi 124 | 125 | if [ ! -x "$JAVACMD" ] ; then 126 | echo "Error: JAVA_HOME is not defined correctly." >&2 127 | echo " We cannot execute $JAVACMD" >&2 128 | exit 1 129 | fi 130 | 131 | if [ -z "$JAVA_HOME" ] ; then 132 | echo "Warning: JAVA_HOME environment variable is not set." 133 | fi 134 | 135 | # traverses directory structure from process work directory to filesystem root 136 | # first directory with .mvn subdirectory is considered project base directory 137 | find_maven_basedir() { 138 | if [ -z "$1" ] 139 | then 140 | echo "Path not specified to find_maven_basedir" 141 | return 1 142 | fi 143 | 144 | basedir="$1" 145 | wdir="$1" 146 | while [ "$wdir" != '/' ] ; do 147 | if [ -d "$wdir"/.mvn ] ; then 148 | basedir=$wdir 149 | break 150 | fi 151 | # workaround for JBEAP-8937 (on Solaris 10/Sparc) 152 | if [ -d "${wdir}" ]; then 153 | wdir=$(cd "$wdir/.." || exit 1; pwd) 154 | fi 155 | # end of workaround 156 | done 157 | printf '%s' "$(cd "$basedir" || exit 1; pwd)" 158 | } 159 | 160 | # concatenates all lines of a file 161 | concat_lines() { 162 | if [ -f "$1" ]; then 163 | # Remove \r in case we run on Windows within Git Bash 164 | # and check out the repository with auto CRLF management 165 | # enabled. Otherwise, we may read lines that are delimited with 166 | # \r\n and produce $'-Xarg\r' rather than -Xarg due to word 167 | # splitting rules. 168 | tr -s '\r\n' ' ' < "$1" 169 | fi 170 | } 171 | 172 | log() { 173 | if [ "$MVNW_VERBOSE" = true ]; then 174 | printf '%s\n' "$1" 175 | fi 176 | } 177 | 178 | BASE_DIR=$(find_maven_basedir "$(dirname "$0")") 179 | if [ -z "$BASE_DIR" ]; then 180 | exit 1; 181 | fi 182 | 183 | MAVEN_PROJECTBASEDIR=${MAVEN_BASEDIR:-"$BASE_DIR"}; export MAVEN_PROJECTBASEDIR 184 | log "$MAVEN_PROJECTBASEDIR" 185 | 186 | ########################################################################################## 187 | # Extension to allow automatically downloading the maven-wrapper.jar from Maven-central 188 | # This allows using the maven wrapper in projects that prohibit checking in binary data. 189 | ########################################################################################## 190 | wrapperJarPath="$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.jar" 191 | if [ -r "$wrapperJarPath" ]; then 192 | log "Found $wrapperJarPath" 193 | else 194 | log "Couldn't find $wrapperJarPath, downloading it ..." 195 | 196 | if [ -n "$MVNW_REPOURL" ]; then 197 | wrapperUrl="$MVNW_REPOURL/org/apache/maven/wrapper/maven-wrapper/3.2.0/maven-wrapper-3.2.0.jar" 198 | else 199 | wrapperUrl="https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.2.0/maven-wrapper-3.2.0.jar" 200 | fi 201 | while IFS="=" read -r key value; do 202 | # Remove '\r' from value to allow usage on windows as IFS does not consider '\r' as a separator ( considers space, tab, new line ('\n'), and custom '=' ) 203 | safeValue=$(echo "$value" | tr -d '\r') 204 | case "$key" in (wrapperUrl) wrapperUrl="$safeValue"; break ;; 205 | esac 206 | done < "$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.properties" 207 | log "Downloading from: $wrapperUrl" 208 | 209 | if $cygwin; then 210 | wrapperJarPath=$(cygpath --path --windows "$wrapperJarPath") 211 | fi 212 | 213 | if command -v wget > /dev/null; then 214 | log "Found wget ... using wget" 215 | [ "$MVNW_VERBOSE" = true ] && QUIET="" || QUIET="--quiet" 216 | if [ -z "$MVNW_USERNAME" ] || [ -z "$MVNW_PASSWORD" ]; then 217 | wget $QUIET "$wrapperUrl" -O "$wrapperJarPath" || rm -f "$wrapperJarPath" 218 | else 219 | wget $QUIET --http-user="$MVNW_USERNAME" --http-password="$MVNW_PASSWORD" "$wrapperUrl" -O "$wrapperJarPath" || rm -f "$wrapperJarPath" 220 | fi 221 | elif command -v curl > /dev/null; then 222 | log "Found curl ... using curl" 223 | [ "$MVNW_VERBOSE" = true ] && QUIET="" || QUIET="--silent" 224 | if [ -z "$MVNW_USERNAME" ] || [ -z "$MVNW_PASSWORD" ]; then 225 | curl $QUIET -o "$wrapperJarPath" "$wrapperUrl" -f -L || rm -f "$wrapperJarPath" 226 | else 227 | curl $QUIET --user "$MVNW_USERNAME:$MVNW_PASSWORD" -o "$wrapperJarPath" "$wrapperUrl" -f -L || rm -f "$wrapperJarPath" 228 | fi 229 | else 230 | log "Falling back to using Java to download" 231 | javaSource="$MAVEN_PROJECTBASEDIR/.mvn/wrapper/MavenWrapperDownloader.java" 232 | javaClass="$MAVEN_PROJECTBASEDIR/.mvn/wrapper/MavenWrapperDownloader.class" 233 | # For Cygwin, switch paths to Windows format before running javac 234 | if $cygwin; then 235 | javaSource=$(cygpath --path --windows "$javaSource") 236 | javaClass=$(cygpath --path --windows "$javaClass") 237 | fi 238 | if [ -e "$javaSource" ]; then 239 | if [ ! -e "$javaClass" ]; then 240 | log " - Compiling MavenWrapperDownloader.java ..." 241 | ("$JAVA_HOME/bin/javac" "$javaSource") 242 | fi 243 | if [ -e "$javaClass" ]; then 244 | log " - Running MavenWrapperDownloader.java ..." 245 | ("$JAVA_HOME/bin/java" -cp .mvn/wrapper MavenWrapperDownloader "$wrapperUrl" "$wrapperJarPath") || rm -f "$wrapperJarPath" 246 | fi 247 | fi 248 | fi 249 | fi 250 | ########################################################################################## 251 | # End of extension 252 | ########################################################################################## 253 | 254 | # If specified, validate the SHA-256 sum of the Maven wrapper jar file 255 | wrapperSha256Sum="" 256 | while IFS="=" read -r key value; do 257 | case "$key" in (wrapperSha256Sum) wrapperSha256Sum=$value; break ;; 258 | esac 259 | done < "$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.properties" 260 | if [ -n "$wrapperSha256Sum" ]; then 261 | wrapperSha256Result=false 262 | if command -v sha256sum > /dev/null; then 263 | if echo "$wrapperSha256Sum $wrapperJarPath" | sha256sum -c > /dev/null 2>&1; then 264 | wrapperSha256Result=true 265 | fi 266 | elif command -v shasum > /dev/null; then 267 | if echo "$wrapperSha256Sum $wrapperJarPath" | shasum -a 256 -c > /dev/null 2>&1; then 268 | wrapperSha256Result=true 269 | fi 270 | else 271 | echo "Checksum validation was requested but neither 'sha256sum' or 'shasum' are available." 272 | echo "Please install either command, or disable validation by removing 'wrapperSha256Sum' from your maven-wrapper.properties." 273 | exit 1 274 | fi 275 | if [ $wrapperSha256Result = false ]; then 276 | echo "Error: Failed to validate Maven wrapper SHA-256, your Maven wrapper might be compromised." >&2 277 | echo "Investigate or delete $wrapperJarPath to attempt a clean download." >&2 278 | echo "If you updated your Maven version, you need to update the specified wrapperSha256Sum property." >&2 279 | exit 1 280 | fi 281 | fi 282 | 283 | MAVEN_OPTS="$(concat_lines "$MAVEN_PROJECTBASEDIR/.mvn/jvm.config") $MAVEN_OPTS" 284 | 285 | # For Cygwin, switch paths to Windows format before running java 286 | if $cygwin; then 287 | [ -n "$JAVA_HOME" ] && 288 | JAVA_HOME=$(cygpath --path --windows "$JAVA_HOME") 289 | [ -n "$CLASSPATH" ] && 290 | CLASSPATH=$(cygpath --path --windows "$CLASSPATH") 291 | [ -n "$MAVEN_PROJECTBASEDIR" ] && 292 | MAVEN_PROJECTBASEDIR=$(cygpath --path --windows "$MAVEN_PROJECTBASEDIR") 293 | fi 294 | 295 | # Provide a "standardized" way to retrieve the CLI args that will 296 | # work with both Windows and non-Windows executions. 297 | MAVEN_CMD_LINE_ARGS="$MAVEN_CONFIG $*" 298 | export MAVEN_CMD_LINE_ARGS 299 | 300 | WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain 301 | 302 | # shellcheck disable=SC2086 # safe args 303 | exec "$JAVACMD" \ 304 | $MAVEN_OPTS \ 305 | $MAVEN_DEBUG_OPTS \ 306 | -classpath "$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.jar" \ 307 | "-Dmaven.multiModuleProjectDirectory=${MAVEN_PROJECTBASEDIR}" \ 308 | ${WRAPPER_LAUNCHER} $MAVEN_CONFIG "$@" 309 | --------------------------------------------------------------------------------