Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yusufugurozbek/testcontainers-port-updater
You are using Testcontainers and want to have your Testcontainers database accessible directly within IntelliJ? You are tired of changing the port configuration all the time since Testcontainers chooses a random port on each startup? This plugin solves your issue.
https://github.com/yusufugurozbek/testcontainers-port-updater
intellij intellij-idea intellij-plugin intellij-plugins testcontainers testcontainers-port-updater
Last synced: 3 months ago
JSON representation
You are using Testcontainers and want to have your Testcontainers database accessible directly within IntelliJ? You are tired of changing the port configuration all the time since Testcontainers chooses a random port on each startup? This plugin solves your issue.
- Host: GitHub
- URL: https://github.com/yusufugurozbek/testcontainers-port-updater
- Owner: yusufugurozbek
- License: mit
- Created: 2021-05-18T12:07:52.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-09-25T19:37:42.000Z (3 months ago)
- Last Synced: 2024-09-27T05:20:27.283Z (3 months ago)
- Topics: intellij, intellij-idea, intellij-plugin, intellij-plugins, testcontainers, testcontainers-port-updater
- Language: Kotlin
- Homepage:
- Size: 824 KB
- Stars: 26
- Watchers: 2
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Testcontainers Port Updater
[](https://github.com/yusufugurozbek/testcontainers-port-updater/actions/workflows/release.yml)
[](https://plugins.jetbrains.com/plugin/17116-testcontainers-port-updater)
[](https://plugins.jetbrains.com/plugin/17116-testcontainers-port-updater)
You are using Testcontainers and want to have your Testcontainers database accessible directly within IntelliJ? You are tired of changing the port configuration all the time since Testcontainers chooses a random port on each startup? This plugin solves your issue.
It automatically updates the IntelliJ data source port number with the exposed random port number that Testcontainers chose on startup.
If you don't know what is Testcontainers, please check their official web page https://www.testcontainers.org/
## Installation
- Using IDE built-in plugin system:
Settings/Preferences > Plugins > Marketplace > Search for "Testcontainers Port Updater" >
Install Plugin
- Manually:
Download the [latest release](https://github.com/yusufugurozbek/testcontainers-port-updater/releases/latest) and install it manually using
Settings/Preferences > Plugins > ⚙️ > Install plugin from disk...
## Usage
For having a working plugin, there are 2 requirements;
1- The plugin expects that your application writes a log that starts with the log entry prefix (default log entry prefix is `Database:`).
If you don't see any logs on your console, please check your configurations and your log level.
Example log;
```
2021-06-23 14:07:26.408 INFO [your-service,,] 11111 --- [ main] o.f.c.i.database.base.DatabaseType : Database: jdbc:postgresql://localhost:12345/test (PostgreSQL 10.13)
```
2- Copy the URL (`jdbc:postgresql://localhost:12345/test`) from the console log and add it to your IntelliJ as a new data source.
For more details, please visit [this page](https://www.jetbrains.com/help/idea/connecting-to-a-database.html) from IntelliJ.
After covering these 2 requirements, the plugin automatically will catch the log and update the matched data source URL with the Testcontainers' one.
### Plugin Settings
To adjust Testcontainers Port Updater plugin settings, open IntelliJ preferences and navigate to **Tools | Testcontainers Port Updater**.
Please be aware, settings are stored at the project level, so each project has its own settings.
#### - `Enable notifications` Enable/disable 'Updated data source URL' notifications
#### - `Enter log entry prefix` Default is `Database:`
#### - `Select match mode`
- `Exact match`
Logged data source URL and IntelliJ data source URL should be the same ignoring port part. Example match will be:
Logged data source URL: `Database: jdbc:postgresql://localhost:11111/test?loggerLevel=OFF`
IntelliJ data source URL: `jdbc:postgresql://localhost:22222/test?loggerLevel=OFF`
- `Everything`
Before the port part (`jdbc:postgresql://localhost`) should be the same for the logged data source URL and IntelliJ data source URL. Example match will be:
Logged data source URL: `Database: jdbc:postgresql://localhost:11111/test`
IntelliJ data source URL: `jdbc:postgresql://localhost:22222/test?loggerLevel=OFF`
- `With testcontainers=true parameter`
IntelliJ data source URL should contain `testcontainers=true` and before the port part (`jdbc:postgresql://localhost`) should be the same\
for the logged data source URL and IntelliJ data source URL. Example match will be:
Logged data source URL: `Database: jdbc:postgresql://localhost:11111/test?loggerLevel=OFF`
IntelliJ data source URL: `jdbc:postgresql://localhost:22222/test?testcontainers=true`
---
Plugin based on the [IntelliJ Platform Plugin Template][template].
[template]: https://github.com/JetBrains/intellij-platform-plugin-template