Skip to content

IJMP-1923 Fixed IDE error in case of invalid zowe.config #209

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 13, 2024
Merged

IJMP-1923 Fixed IDE error in case of invalid zowe.config #209

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d742a64
IJMP-1923 Fixed IDE error in case of invalid zowe.config
Nov 5, 2024
4d091b8
IJMP-1923 Fixed adding invalid connections from Zowe config file
Nov 13, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 14 additions & 1 deletion src/main/kotlin/org/zowe/explorer/config/connect/ui/zosmf/ZOSMFConnectionConfigurable.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,9 @@

package org.zowe.explorer.config.connect.ui.zosmf

import com.google.gson.JsonSyntaxException
import com.intellij.ide.DataManager
import com.intellij.openapi.actionSystem.*
import com.intellij.openapi.application.ApplicationManager
import com.intellij.openapi.application.runInEdt
import com.intellij.openapi.options.BoundSearchableConfigurable
Expand All @@ -34,6 +37,7 @@ import org.zowe.explorer.config.connect.Credentials
import org.zowe.explorer.config.ws.FilesWorkingSetConfig
import org.zowe.explorer.config.ws.JesWorkingSetConfig
import org.zowe.explorer.config.ws.WorkingSetConfig
import org.zowe.explorer.telemetry.NotificationsService
import org.zowe.explorer.utils.crudable.getAll
import org.zowe.explorer.utils.isThe
import org.zowe.explorer.utils.runWriteActionInEdtAndWait
Expand Down Expand Up @@ -109,7 +113,16 @@ class ZOSMFConnectionConfigurable : BoundSearchableConfigurable("z/OSMF Connecti
return
}

val zoweConfig = parseConfigJson(configFile.inputStream)
val zoweConfig = try {
parseConfigJson(configFile.inputStream)
} catch (e: JsonSyntaxException) {
NotificationsService.errorNotification(
e,
project = DataManager.getInstance().getDataContext(panel).getData(PlatformDataKeys.PROJECT),
custTitle = "Error with Zowe config file"
)
return
}
zoweConfig.extractSecureProperties(configFile.path.split("/").toTypedArray())
kotlin.runCatching {
zoweConfig.updateFromState(state)
Expand Down
18 changes: 12 additions & 6 deletions src/main/kotlin/org/zowe/explorer/zowe/actions/UpdateZoweConfigAction.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@

package org.zowe.explorer.zowe.actions

import com.google.gson.JsonSyntaxException
import com.intellij.openapi.actionSystem.ActionUpdateThread
import com.intellij.openapi.actionSystem.AnActionEvent
import com.intellij.openapi.actionSystem.CommonDataKeys
Expand Down Expand Up @@ -84,12 +85,17 @@ class UpdateZoweConfigAction : DumbAwareAction() {
zoweConfigService.localZoweConfig
else
zoweConfigService.globalZoweConfig
if (type == ZoweConfigType.LOCAL) {
zoweConfigService.localZoweConfig = parseConfigJson(editor.document.text)
zoweConfigService.localZoweConfig?.extractSecureProperties(vFile.path.split("/").toTypedArray())
} else {
zoweConfigService.globalZoweConfig = parseConfigJson(editor.document.text)
zoweConfigService.globalZoweConfig?.extractSecureProperties(vFile.path.split("/").toTypedArray())
try {
if (type == ZoweConfigType.LOCAL) {
zoweConfigService.localZoweConfig = parseConfigJson(editor.document.text)
zoweConfigService.localZoweConfig?.extractSecureProperties(vFile.path.split("/").toTypedArray())
} else {
zoweConfigService.globalZoweConfig = parseConfigJson(editor.document.text)
zoweConfigService.globalZoweConfig?.extractSecureProperties(vFile.path.split("/").toTypedArray())
}
} catch (ex: JsonSyntaxException) {
e.presentation.isEnabledAndVisible = false
return
}
val zoweState = zoweConfigService.getZoweConfigState(false, type = type)
e.presentation.isEnabledAndVisible =
Expand Down
186 changes: 80 additions & 106 deletions src/main/kotlin/org/zowe/explorer/zowe/service/ZoweConfigServiceImpl.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,8 @@

package org.zowe.explorer.zowe.service

import com.intellij.notification.Notification
import com.intellij.notification.NotificationGroupManager
import com.intellij.notification.NotificationType
import com.intellij.notification.Notifications
import com.intellij.openapi.actionSystem.AnActionEvent
import com.intellij.openapi.application.runReadAction
import com.intellij.openapi.application.runWriteAction
Expand All @@ -38,6 +36,7 @@ import org.zowe.explorer.dataops.DataOpsManager
import org.zowe.explorer.dataops.operations.InfoOperation
import org.zowe.explorer.dataops.operations.ZOSInfoOperation
import org.zowe.explorer.explorer.EXPLORER_NOTIFICATION_GROUP_ID
import org.zowe.explorer.telemetry.NotificationsService
import org.zowe.explorer.utils.crudable.find
import org.zowe.explorer.utils.crudable.getAll
import org.zowe.explorer.utils.runTask
Expand All @@ -64,9 +63,6 @@ import java.util.regex.Pattern
import java.util.stream.Collectors
import kotlin.collections.set


const val ZOWE_CONFIG_NOTIFICATION_GROUP_ID = "org.zowe.explorerzowe.service.ZoweConfigNotificationGroupId"

const val ZOWE_PROJECT_PREFIX = "zowe-"

/**
Expand Down Expand Up @@ -123,22 +119,6 @@ class ZoweConfigServiceImpl(override val myProject: Project) : ZoweConfigService

override var globalZoweConfig: ZoweConfig? = null

/**
* Displays an error notification if an error was received.
* @param t thrown error.
* @param title error text.
*/
private fun notifyError(t: Throwable, title: String? = null) {
Notifications.Bus.notify(
Notification(
ZOWE_CONFIG_NOTIFICATION_GROUP_ID,
title ?: "Error with Zowe config file",
t.message ?: t.toString(),
NotificationType.ERROR
)
)
}

/**
* Checks project contains zowe.config.json. If zowe config presented
* it will parse it and save to object model inside zoweConfig field.
Expand All @@ -162,7 +142,8 @@ class ZoweConfigServiceImpl(override val myProject: Project) : ZoweConfigService
}
}
} catch (e: Exception) {
throw Exception("Cannot parse $type Zowe config file")
NotificationsService.errorNotification(e, project = myProject, custTitle="Error with Zowe config file")
return null
}
}

Expand Down Expand Up @@ -208,8 +189,8 @@ class ZoweConfigServiceImpl(override val myProject: Project) : ZoweConfigService

/**
* Added notification about connection failure with action of force connection adding.
* @param title - notification title.
* @param content - notification content.
* @param title notification title.
* @param content notification content.
* @return Nothing.
*/
private fun notifyUiOnConnectionFailure(title: String, content: String, type: ZoweConfigType) {
Expand Down Expand Up @@ -277,27 +258,23 @@ class ZoweConfigServiceImpl(override val myProject: Project) : ZoweConfigService
this.globalZoweConfig
zoweConfig ?: throw Exception("Cannot get $type Zowe config")

var allPreparedConn = mutableListOf<ConnectionConfig>()
if (checkConnection) {
val failedURLs = mutableListOf<String>()
allPreparedConn = testAndPrepareAllZosmfConnections(zoweConfig, type, failedURLs)
if (failedURLs.isNotEmpty()) {
val andMore = if (failedURLs.size > 3)
"..."
else
""
notifyUiOnConnectionFailure(
"Connection failed to:",
"${failedURLs.joinToString(separator = ", <p>")} ${andMore}",
type
)
return
}
val (allPreparedConn, failedConnections) = testAndPrepareAllZosmfConnections(zoweConfig, type)
if (checkConnection and failedConnections.isNotEmpty()) {
val andMore = if (failedConnections.size > 3) "..." else ""
notifyUiOnConnectionFailure(
"Connection failed to:",
"${failedConnections.map{it.url}.joinToString(separator = ", <p>")} $andMore",
type
)
}
for (zosmfConnection in allPreparedConn) {
val conToAdd = if (checkConnection)
allPreparedConn.subtract(failedConnections.toSet())
else
allPreparedConn
conToAdd.forEach { zosmfConnection ->
val connectionOpt = configCrudable.addOrUpdate(zosmfConnection)
if (!connectionOpt.isEmpty) {
var topic = if (type == ZoweConfigType.LOCAL)
val topic = if (type == ZoweConfigType.LOCAL)
LOCAL_ZOWE_CONFIG_CHANGED
else
GLOBAL_ZOWE_CONFIG_CHANGED
Expand All @@ -306,7 +283,7 @@ class ZoweConfigServiceImpl(override val myProject: Project) : ZoweConfigService
}

} catch (e: Exception) {
notifyError(e)
NotificationsService.errorNotification(e, project = myProject, custTitle="Error with Zowe config file")
}
}

Expand All @@ -319,9 +296,9 @@ class ZoweConfigServiceImpl(override val myProject: Project) : ZoweConfigService
private fun prepareConnection(zosmfConnection: ZOSConnection, type: ZoweConfigType): ConnectionConfig {
val username = zosmfConnection.user
val password = zosmfConnection.password
val zoweConnection = findExistingConnection(type, zosmfConnection.profileName)?.let {
zosmfConnection.toConnectionConfig(it.uuid, it.zVersion, type = type)
} ?: zosmfConnection.toConnectionConfig(UUID.randomUUID().toString(), type = type)
val zoweConnection = findExistingConnection(type, zosmfConnection.profileName)
?.let { zosmfConnection.toConnectionConfig(it.uuid, it.zVersion, type = type) }
?: zosmfConnection.toConnectionConfig(UUID.randomUUID().toString(), type = type)
CredentialService.getService().setCredentials(zoweConnection.uuid, username, password)
return zoweConnection
}
Expand All @@ -330,24 +307,25 @@ class ZoweConfigServiceImpl(override val myProject: Project) : ZoweConfigService
* Convert all zosmf connections from zowe config file to ConnectionConfig and tests them
* @param zoweConfig
* @param type of zowe config
* @return list of URLs which did not pass the test
* @return pair of lists, one is the connections list, the second is the list of URLs which did not pass the test
*/
private fun testAndPrepareAllZosmfConnections(
zoweConfig: ZoweConfig,
type: ZoweConfigType,
failedURLs: MutableList<String>
): MutableList<ConnectionConfig> {
var allPreparedConn = mutableListOf<ConnectionConfig>()
for (zosmfConnection in zoweConfig.getListOfZosmfConections()) {
val zoweConnection = prepareConnection(zosmfConnection, type)
try {
testAndPrepareConnection(zoweConnection)
} catch (t: Throwable) {
failedURLs.add(zoweConnection.url)
type: ZoweConfigType
): Pair<List<ConnectionConfig>, List<ConnectionConfig>> {
return zoweConfig.getListOfZosmfConections()
.fold(
mutableListOf<ConnectionConfig>() to mutableListOf<ConnectionConfig>()
) { (allConnectionConfigs, failedURLs), zosmfConnection ->
val zoweConnection = prepareConnection(zosmfConnection, type)
try {
testAndPrepareConnection(zoweConnection)
} catch (t: Throwable) {
failedURLs.add(zoweConnection)
}
allConnectionConfigs.add(zoweConnection)
allConnectionConfigs to failedURLs
}
allPreparedConn.add(zoweConnection)
}
return allPreparedConn
}

/**
Expand Down Expand Up @@ -384,7 +362,7 @@ class ZoweConfigServiceImpl(override val myProject: Project) : ZoweConfigService
}

} catch (e: Exception) {
notifyError(e)
NotificationsService.errorNotification(e, project = myProject, custTitle="Error with Zowe config file")
}
}

Expand Down Expand Up @@ -434,18 +412,20 @@ class ZoweConfigServiceImpl(override val myProject: Project) : ZoweConfigService
val allConnections = configCrudable.getAll<ConnectionConfig>().toList()
val allConnectionsNames: MutableList<String> = allConnections.map { it.name }.toMutableList()

allConnections.filter { it.zoweConfigPath == getZoweConfigLocation(myProject, type) }.forEach {
var index = 1
var newName = it.name
while (allConnectionsNames.contains(newName)) {
newName = it.name.plus(index.toString())
index++
allConnections
.filter { it.zoweConfigPath == getZoweConfigLocation(myProject, type) }
.forEach {
var index = 1
var newName = it.name
while (allConnectionsNames.contains(newName)) {
newName = it.name.plus(index.toString())
index++
}
allConnectionsNames.add(newName)
it.name = newName
it.zoweConfigPath = null
configCrudable.update(it)
}
allConnectionsNames.add(newName)
it.name = newName
it.zoweConfigPath = null
configCrudable.update(it)
}
}

private fun createZoweSchemaJsonIfNotExists() {
Expand Down Expand Up @@ -490,51 +470,45 @@ class ZoweConfigServiceImpl(override val myProject: Project) : ZoweConfigService
*/
override fun getZoweConfigState(scanProject: Boolean, type: ZoweConfigType): ZoweConfigState {
if (scanProject) {
try {
scanForZoweConfig(type)
} catch (e: Exception) {
notifyError(e)
}
}
val zoweConfig = if (type == ZoweConfigType.LOCAL)
localZoweConfig ?: return ZoweConfigState.NOT_EXISTS
else
globalZoweConfig ?: return ZoweConfigState.NOT_EXISTS

findAllZosmfExistingConnection(type) ?: return ZoweConfigState.NEED_TO_ADD
var ret = ZoweConfigState.SYNCHRONIZED

for (zosConnection in zoweConfig.getListOfZosmfConections()) {
val existingConnection =
findExistingConnection(type, zosConnection.profileName)
if (existingConnection == null)
ret = setZoweConfigState(ret, ZoweConfigState.NEED_TO_ADD)
else {
val newConnectionList = zoweConfig.getListOfZosmfConections()
.filter { it.profileName == getProfileNameFromConnName(existingConnection.name) }
val newConnection = if (newConnectionList.isNotEmpty()) {
newConnectionList[0].toConnectionConfig(
existingConnection.uuid.toString(), existingConnection.zVersion, existingConnection.owner, type = type
)
} else {
ret = setZoweConfigState(ret, ZoweConfigState.NEED_TO_ADD)
continue
}
val zoweUsername = zosConnection.user
val zowePassword = zosConnection.password

ret = if (
existingConnection == newConnection
&& CredentialService.getUsername(newConnection) == zoweUsername
&& CredentialService.getPassword(newConnection) == zowePassword
) {
setZoweConfigState(ret, ZoweConfigState.SYNCHRONIZED)

return zoweConfig
.getListOfZosmfConections()
.fold(ZoweConfigState.SYNCHRONIZED) { prevZoweConfigState, zosConnection ->
val existingConnection = findExistingConnection(type, zosConnection.profileName)
val currZoweConfigState = if (existingConnection == null) {
ZoweConfigState.NEED_TO_ADD
} else {
setZoweConfigState(ret, ZoweConfigState.NEED_TO_UPDATE)
val newConnectionList = zoweConfig.getListOfZosmfConections()
.filter { it.profileName == getProfileNameFromConnName(existingConnection.name) }
if (newConnectionList.isNotEmpty()) {
val newConnection = newConnectionList[0].toConnectionConfig(
existingConnection.uuid, existingConnection.zVersion, existingConnection.owner, type = type
)
val zoweUsername = zosConnection.user
val zowePassword = zosConnection.password
if (
existingConnection == newConnection
&& CredentialService.getUsername(newConnection) == zoweUsername
&& CredentialService.getPassword(newConnection) == zowePassword
) {
ZoweConfigState.SYNCHRONIZED
} else {
ZoweConfigState.NEED_TO_UPDATE
}
} else {
ZoweConfigState.NEED_TO_ADD
}
}
setZoweConfigState(prevZoweConfigState, currZoweConfigState)
}
}
return ret
}

/**
Expand Down
Loading