https://github.com/al-rimi/tom-script
Maven package Tomcat redeploy Chrome reload Life easier
https://github.com/al-rimi/tom-script
java-server jsp maven-tomcat powershell-script tomcat-redeploy
Last synced: 8 months ago
JSON representation
Maven package Tomcat redeploy Chrome reload Life easier
- Host: GitHub
- URL: https://github.com/al-rimi/tom-script
- Owner: Al-rimi
- License: mit
- Created: 2025-03-01T22:53:55.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2025-03-02T09:24:07.000Z (8 months ago)
- Last Synced: 2025-03-02T09:30:49.790Z (8 months ago)
- Topics: java-server, jsp, maven-tomcat, powershell-script, tomcat-redeploy
- Language: PowerShell
- Homepage:
- Size: 36.1 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Tomcat Automation Script
This PowerShell script automates the process of building, deploying, and managing JSP web applications on Apache Tomcat, opening the browser, and reloading the page with no user interaction.
## Features
Automatically builds projects using Maven
This feature ensures that the project is built using Maven, compiling the source code and generating a deployable WAR file.
```powershell
$process = Start-Process -FilePath "mvn" -ArgumentList "clean package" -PassThru -Wait -NoNewWindow
if ($process.ExitCode -ne 0) {
Write-Host "[ERROR] Maven build failed. Exiting." -ForegroundColor Red | Out-Null
exit 1
}
```
Explanation: The script starts the Maven process using `mvn clean package`. If the Maven build fails (i.e., the exit code is non-zero), an error message is displayed, and the script terminates.
Deploys WAR files to the Tomcat `webapps` directory
Once the Maven build completes successfully, the generated WAR file is deployed to the Tomcat `webapps` directory.
```powershell
$WAR_FILE = Get-ChildItem -Path "$PROJECT_DIR\target" -Filter "*.war" | Select-Object -First 1 -ExpandProperty FullName
$APP_NAME = [System.IO.Path]::GetFileNameWithoutExtension($WAR_FILE)
if (-not $WAR_FILE) {
Write-Host "[ERROR] No WAR file found. Closing Tomcat..." -ForegroundColor Red
exit 1
}
Copy-Item -Path $WAR_FILE -Destination "$TOMCAT_HOME\webapps\"
INFO "New WAR file deployed"
```
Explanation: The script searches for the WAR file in the project's target directory and deploys it to the Tomcat `webapps` directory. If no WAR file is found, it terminates with an error message.
Starts or stops Tomcat based on its running status
The script includes functionality to start or stop Tomcat depending on the given action (`start` or `stop`).
```powershell
function Tomcat {
param (
[ValidateSet("start", "stop")]
[string]$Action
)
$javaExecutable = "$env:JAVA_HOME\bin\java.exe"
Start-Process -FilePath $javaExecutable `
-ArgumentList "-cp", $classpath, $catalinaOpts, $mainClass, $Action `
-NoNewWindow `
-RedirectStandardOutput $logOut `
-RedirectStandardError $logErr `
-Wait
}
```
Explanation: The `Tomcat` function takes an action parameter (`start` or `stop`) and starts or stops the Tomcat server accordingly by executing the Java process with the appropriate arguments. If Tomcat is not already running, it can be started; if it is running, it can be stopped.
Reloads the application if Tomcat is already running
If Tomcat is already running, the script will reload the application rather than restarting the server.
```powershell
if ($tomcatRunning) {
try {
$creds = New-Object System.Management.Automation.PSCredential("admin", (ConvertTo-SecureString "admin" -AsPlainText -Force))
Invoke-WebRequest -Uri "http://localhost:8080/manager/text/reload?path=/$APP_NAME" -Method Get -Credential $creds | Out-Null
INFO "Tomcat reloaded"
} catch {
Write-Host "[ERROR] Failed to reload Tomcat. Check your credentials and Tomcat manager settings." -ForegroundColor Red
exit 1
}
} else {
Tomcat -Action start
}
```
Explanation: If Tomcat is running, the script uses the Tomcat manager's API to reload the application without restarting the server. If Tomcat is not running, it starts the server first. **Note:** The script will crash if the following line is not added to `apache-tomcat\conf\tomcat-users.xml`:
```xml
```
This line grants the necessary permissions to the Tomcat manager for reloading the application.
### For Newer PowerShell Versions:
In newer versions of PowerShell, you might need to include the `-AllowUnencryptedAuthentication` flag when running the script to enable basic authentication for the Tomcat manager API. The rest of the command should remain unchanged.
Example:
```powershell
Invoke-WebRequest -Uri "http://localhost:8080/manager/text/reload?path=/$APP_NAME" -Method Get -Credential $creds -AllowUnencryptedAuthentication
```
Without this flag, you might encounter errors related to unencrypted communication during authentication.
Opens or refreshes the application in Google Chrome
The script ensures the application is opened or refreshed in Google Chrome after deployment.
```powershell
$chromeProcesses = Get-Process -Name "chrome" -ErrorAction SilentlyContinue
if ($chromeProcesses) {
$chromeOpened = $false
foreach ($process in $chromeProcesses) {
$chromeTitle = $process.MainWindowTitle
if ($chromeTitle -like "*$APP_NAME*") {
$chromeOpened = $true
[System.Windows.Forms.SendKeys]::SendWait("^{F5}") # Ctrl+F5 for hard refresh
INFO "Google Chrome reloaded"
break
}
}
if (-not $chromeOpened) {
INFO "Opening Google Chrome"
Start-Process "chrome" "http://localhost:8080/$APP_NAME"
}
} else {
INFO "Opening Google Chrome"
Start-Process "chrome" "http://localhost:8080/$APP_NAME"
}
```
Explanation: The script checks if Google Chrome is already open and refreshes the tab with the deployed application. If Chrome is not open, it launches a new instance with the application URL.
## Parameter Actions
| Action | Description |
|----------|--------------------------------------|
| start | Starts the Tomcat server |
| stop | Stops the Tomcat server |
| deploy | Deploys the WAR file to Tomcat |
| clean | Cleans previous deployments |
| auto | Automates the entire process |
| help | Displays help message |
## Prerequisites
Before using this script, ensure the following requirements are met:
1. **[Java Development Kit (JDK)](https://www.oracle.com/java/technologies/javase-jdk11-downloads.html)**: Installed and `JAVA_HOME` environment variable is correctly set.
2. **[Apache Tomcat](https://tomcat.apache.org/download-90.cgi)**: Installed and `CATALINA_HOME` environment variable is correctly set.
3. **[Maven](https://maven.apache.org/download.cgi)**: Installed and added to the system's `PATH`.
4. **[Google Chrome](https://www.google.com/chrome/)**: Installed for automatic browser interaction.
### This script assumes that the working directory contains the pom.xml file, indicating a valid Maven project. If the pom.xml is missing, the script will not run.
### Extendable Code
This script is designed to be **extendable**. You can add new functionality such as pre-deployment checks, custom notifications, or integrate with other tools.
### Add Custom Future Extensions:
- **Custom Deployment Notifications**: You can modify the script to send email or Slack notifications after deployment.
- **Custom Build Scripts**: Add new Maven goals or other build scripts as part of the mvn clean package command.
## VS Code Automatic Execution
For Visual Studio Code users, the script can be configured to run automatically on file save using the **Run on Save** extension.
1. Install the extension from this repository: [vscode-run-on-save](https://github.com/pucelle/vscode-run-on-save).
2. Add the following configuration to your VS Code settings:
```json
"runOnSave.shell": "PowerShell",
"runOnSave.commands": [
{
"match": ".*$",
"command": "tom"
}
],
"runOnSave.defaultRunIn": "terminal"
```
## Error Handling
- If **JAVA_HOME** or **CATALINA_HOME** is not set correctly, the script will terminate with an appropriate error message.
- Maven build failures will stop further deployment.
- Missing WAR files will prompt Tomcat shutdown before exit.
## License
This script is licensed under the MIT [License](License).