https://github.com/zowe/zowe-explorer-intellij
IntelliJ Zowe Plug-in that provides possibility to interact with z/OS features. Has Zowe Kotlin SDK as it's core to interact
https://github.com/zowe/zowe-explorer-intellij
explorer intellij intellij-plugin jcl jes kotlin tso uss zos zos-development zosmf
Last synced: 3 months ago
JSON representation
IntelliJ Zowe Plug-in that provides possibility to interact with z/OS features. Has Zowe Kotlin SDK as it's core to interact
- Host: GitHub
- URL: https://github.com/zowe/zowe-explorer-intellij
- Owner: zowe
- License: epl-2.0
- Created: 2021-06-15T14:44:07.000Z (almost 4 years ago)
- Default Branch: release/v1.1.2-221
- Last Pushed: 2024-04-10T09:11:30.000Z (about 1 year ago)
- Last Synced: 2024-04-10T20:06:38.765Z (about 1 year ago)
- Topics: explorer, intellij, intellij-plugin, jcl, jes, kotlin, tso, uss, zos, zos-development, zosmf
- Language: Kotlin
- Homepage:
- Size: 5.89 MB
- Stars: 9
- Watchers: 7
- Forks: 3
- Open Issues: 26
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Zowe Explorer
[](https://plugins.jetbrains.com/plugin/18688-zowe-explorer)
[](https://plugins.jetbrains.com/plugin/18688-zowe-explorer)
[](https://sonarcloud.io/dashboard?id=zowe_zowe-explorer-intellij)
[](https://sonarcloud.io/dashboard?id=zowe_zowe-explorer-intellij)
"Zowe Explorer" brings support for browsing, editing and creating data on z/OS
via [z/OSMF REST API](https://www.ibm.com/docs/en/zos/2.4.0?topic=guide-using-zosmf-rest-services).
Plugin in Marketplace: [JetBrains Marketplace](https://plugins.jetbrains.com/plugin/18688-zowe-explorer)
Using our plugin you will be able to:
* Start working with z/OS easily with no complex configurations.
* Organize datasets on z/OS, files on USS into Working Sets.
* Allocate datasets, create members, files and directories with different permissions.
* Perform renaming, copying and moving data in a modern way.
* Edit datasets, files and members. Smart auto-save will keep your content both in the editor and on the mainframe
in-sync.
* Create multiple connections to different z/OS systems.
* Perform all available operations with Jobs.
* Highlight all IntelliJ supported languages automatically and recognize them once opened from the mainframe.
To start using the plugin:
* Install the plugin in your Intellij based IDE.
* Contact your RACF administrator so that your user is in
the [IZUUSER RACF group](https://www.ibm.com/docs/en/zos/2.4.0?topic=guide-security-structures-zosmf)
* You are ready to go! Start working with z/OS from the IDE.
**Note: z/OS 2.1 or higher is required**
## Where to find the docs
[Zowe IntelliJ plug-in FAQ](https://docs.zowe.org/stable/getting-started/zowe_faq#zowe-intellij-plug-in-incubator-faq)
[Installing Zowe IntelliJ plug-in](https://docs.zowe.org/stable/user-guide/intellij-install)
[Configuring Zowe IntelliJ plug-in](https://docs.zowe.org/stable/user-guide/intellij-configure)
[Using Zowe IntelliJ plug-in](https://docs.zowe.org/stable/user-guide/intellij-using)
[Troubleshooting Zowe IntelliJ plug-in](https://docs.zowe.org/stable/troubleshoot/troubleshoot-intellij)
[Contribution Guidelines](https://github.com/zowe/zowe-explorer-intellij/blob/main/CONTRIBUTING.md)
[Changelog](https://github.com/zowe/zowe-explorer-intellij/blob/main/CONTRIBUTING.md)
## Developer guide
### Requirements
- IntelliJ IDEA version 2022.3 and later (Community will be enough)
- Java SDK 17 (IntelliJ built-in)
### Setup steps
- Clone the project repo:
``git clone [email protected]:zowe/zowe-explorer-intellij.git``
- Three options of working with the plugin are available:
- **Run plugin** - run the plugin in development mode
- **Package plugin** - make a zip portable package to install it in IntelliJ IDEA or publish somewhere
- **Run tests** - run plugin tests to check the codebase with automated tests
- Proceed to [Contribution Guidelines](#how-to-contribute) to develop some new functionality for the project.
## How to run tests
We have two options of tests:
1. UI tests - run with open IDE, make test of user-like interaction with the plugin;
2. Unit tests - automated headless bundle to test plugin functions as if they were a separate pieces.
### Environment configurations for UI tests:
1. In IntelliJ Idea change Settings => Tools => Terminal Shell path parameter from PowerShell to Git Bash. Example: "C:
\Program Files\Git\usr\bin\bash.exe" --login -i
2. Make Java version 17 available from command line (add to PATH)
### To run UI tests:
1. change values for ZOS_USERID, ZOS_PWD, CONNECTION_URL in src/uiTest/kotlin/auxiliary/utils.kt
2. run the script uiTest.sh
3. once IdeForUiTests started make it as main window on the screen and do not touch mouse anymore
UI tests results: build/reports/tests/uiTest/index.html
### To run smoke test:
1. change values for ZOS_USERID, ZOS_PWD, CONNECTION_URL in src/uiTest/kotlin/auxiliary/utils.kt
2. run the script smokeTest.sh
3. if unit tests fail, smoke ui test will be skipped. When unit tests are successful, IdeForUiTests will be run
4. once IdeForUiTests started make it as main window on the screen and do not touch mouse anymore
Smoke test results: build/reports/tests/test/index.html with report for unit tests,
build/reports/tests/SUCCESS(FAILURE).txt with quick summary for unit test run (file name depends on test run result),
build/reports/tests/smokeUiTest/index.html with report for smoke UI test
### To run unit tests:
"Unit tests" Gradle task: just run it as a configuration option.
If you want to run a separate unit test, you should consider to use "Kotest" plugin.
Firstly, you need to download it. Then, go to "Edit Configurations..." -> "Edit configuration templates..." -> "Kotest".
In there, you need to enable VM options and add the following lines:
```
-Didea.force.use.core.classloader=true
--add-opens=java.desktop/java.awt=ALL-UNNAMED
--add-opens=java.desktop/sun.awt=ALL-UNNAMED
--add-opens=java.desktop/java.awt.event=ALL-UNNAMED
--add-opens=java.base/java.lang=ALL-UNNAMED
--add-exports=java.base/jdk.internal.vm=ALL-UNNAMED
```
After the "Kotest" is set up, just click on the green arrow near the test you want to run.
**In case of any troubles during plugin usage, feel free to contact us.**
## How to contribute
If you want to help the project, improve some functionality, resolve bug or add some new feature, please, refer to
the [contribution guide](CONTRIBUTING.md).
## How to obtain and provide feedback
If you have any questions, related to the project development, further plans or something else, you can reach as out by
some of the communication chanels:
* [For Mainframe Slack channel in IBA workspace](https://iba-mainframe-tools.slack.com/archives/C01V4MZL9DH)
* [Zowe Explorer IntelliJ Slack channel in Open Mainframe Project workspace](https://openmainframeproject.slack.com/archives/C020BGPSU0M)
* [For Mainframe GitHub (create or review issues)](https://github.com/for-mainframe/For-Mainframe/issues)
* [Zowe Explorer IntelliJ GitHub (create or review issues)](https://github.com/zowe/zowe-explorer-intellij/issues)
* Email to: Uladzislau Kalesnikau (Team Lead of the IJMP)
* Email to: Valiantsin Krus (Tech Lead of the IJMP)
**Note: GitHub issue is the preferred way of communicating in case of creating some bug/feature/request for enhancement.
If you need direct consulting or you have any related questions, please, reach us out using Slack channels or E-mail**