Skip to content

Commit e340f68

Browse files
committed
Connection Name was added a while ago, these templates weren't updated with it. The create user one was completely broken and has been for a while, I don't know what I was thinking with I submitted the last PR for it
1 parent a057788 commit e340f68

3 files changed

Lines changed: 15 additions & 15 deletions

File tree

step-templates/mariadb-add-database-user-to-role.json

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,13 @@
33
"Name": "MariaDB - Add Database User To Role",
44
"Description": "Adds a database user to a role",
55
"ActionType": "Octopus.Script",
6-
"Version": 5,
6+
"Version": 6,
77
"Author": "twerthi",
88
"Packages": [],
99
"Properties": {
1010
"Octopus.Action.Script.ScriptSource": "Inline",
1111
"Octopus.Action.Script.Syntax": "PowerShell",
12-
"Octopus.Action.Script.ScriptBody": "# Define functions\nfunction Get-ModuleInstalled \n{\n # Define parameters\n param(\n $PowerShellModuleName\n )\n\n # Check to see if the module is installed\n if ($null -ne (Get-Module -ListAvailable -Name $PowerShellModuleName))\n {\n # It is installed\n return $true\n }\n else\n {\n # Module not installed\n return $false\n }\n}\n\nfunction Install-PowerShellModule\n{\n # Define parameters\n param(\n $PowerShellModuleName,\n $LocalModulesPath\n )\n\n\t# Check to see if the package provider has been installed\n if ((Get-NugetPackageProviderNotInstalled) -ne $false)\n {\n \t# Display that we need the nuget package provider\n Write-Host \"Nuget package provider not found, installing ...\"\n \n # Install Nuget package provider\n Install-PackageProvider -Name Nuget -Force\n }\n\n\t# Save the module in the temporary location\n Save-Module -Name $PowerShellModuleName -Path $LocalModulesPath -Force\n}\n\nfunction Get-NugetPackageProviderNotInstalled\n{\n\t# See if the nuget package provider has been installed\n return ($null -eq (Get-PackageProvider -ListAvailable -Name Nuget -ErrorAction SilentlyContinue))\n}\n\nfunction Get-UserInRole\n{\n\t# Define parameters\n param ($UserHostname,\n $Username,\n $RoleHostName,\n $RoleName)\n \n\t# Execute query\n $grants = Invoke-SqlQuery \"SHOW GRANTS FOR '$Username'@'$UserHostName';\"\n\n # Loop through Grants\n foreach ($grant in $grants.ItemArray)\n {\n # Check grant\n if ($grant -eq \"GRANT $RoleName TO '$Username'@'$UserHostName'\")\n {\n # They're in the group\n return $true\n }\n }\n\n # Not found\n return $false\n}\n\n# Define PowerShell Modules path\n$LocalModules = (New-Item \"$PSScriptRoot\\Modules\" -ItemType Directory -Force).FullName\n$env:PSModulePath = \"$LocalModules$([System.IO.Path]::PathSeparator)$env:PSModulePath\"\n$PowerShellModuleName = \"SimplySql\"\n\n# Set secure protocols\n[System.Net.ServicePointManager]::SecurityProtocol = [System.Net.ServicePointManager]::SecurityProtocol -bor [Net.SecurityProtocolType]::Tls11 -bor [System.Net.SecurityProtocolType]::Tls12\n\n# Check to see if SimplySql module is installed\nif ((Get-ModuleInstalled -PowerShellModuleName $PowerShellModuleName) -ne $true)\n{\n # Tell user what we're doing\n Write-Output \"PowerShell module $PowerShellModuleName is not installed, downloading temporary copy ...\"\n\n # Install temporary copy\n Install-PowerShellModule -PowerShellModuleName $PowerShellModuleName -LocalModulesPath $LocalModules\n}\n\n# Display\nWrite-Output \"Importing module $PowerShellModuleName ...\"\n\n# Check to see if it was downloaded\nif ((Test-Path -Path \"$LocalModules\\$PowerShellModuleName\") -eq $true)\n{\n\t# Use specific location\n $PowerShellModuleName = \"$LocalModules\\$PowerShellModuleName\"\n}\n\n# Declare initial connection string\n$connectionString = \"Server=$addMariaDBServerName;Port=$addMariaDBServerPort;\"\n\n# Update the connection string based on authentication method\nswitch ($mariaDbAuthenticationMethod) {\n \"awsiam\" {\n # Region is part of the RDS endpoint, extract\n $region = ($addMariaDBServerName.Split(\".\"))[2]\n\n Write-Host \"Generating AWS IAM token ...\"\n $addLoginPasswordWithAddRoleRights = (aws rds generate-db-auth-token --hostname $addMariaDBServerName --region $region --port $addMariaDBServerPort --username $addLoginWithAddRoleRights)\n \n # Append remaining portion of connection string\n $connectionString += \";Uid=$addLoginWithAddRoleRights;Pwd=`\"$addLoginPasswordWithAddRoleRights`\";\"\n\n break\n }\n \"usernamepassword\" {\n # Append remaining portion of connection string\n $connectionString += \";Uid=$addLoginWithAddRoleRights;Pwd=`\"$addLoginPasswordWithAddRoleRights`\";\"\n \n break \n }\n \"windowsauthentication\" {\n # Append remaining portion of connection string\n $connectionString += \";IntegratedSecurity=yes;Uid=$addLoginWithAddRoleRights;\"\n\n break\n }\n}\n\n# Import the module\nImport-Module -Name $PowerShellModuleName\n\ntry\n{\n # Connect to MySQL\n Open-MySqlConnection -ConnectionString $connectionString\n\n # See if database exists\n $userInRole = Get-UserInRole -UserHostname $addUserHostname -Username $addUsername -RoleName $addRoleName\n\n if ($userInRole -eq $false)\n {\n # Create database\n Write-Output \"Adding user $addUsername@$addUserHostName to role $addRoleName ...\"\n $executionResults = Invoke-SqlUpdate \"GRANT $addRoleName TO '$addUsername'@'$addUserHostName';\"\n\n # See if it was created\n $userInRole = Get-UserInRole -UserHostname $addUserHostname -Username $addUsername -RoleName $addRoleName\n \n # Check array\n if ($userInRole -eq $true)\n {\n # Success\n Write-Output \"$addUserName@$addUserHostName added to $addRoleName successfully!\"\n }\n else\n {\n # Failed\n Write-Error \"Failure adding $addUserName@$addUserHostName to $addRoleName!\"\n }\n }\n else\n {\n \t# Display message\n Write-Output \"User $addUsername@$addUserHostName is already in role $addRoleName\"\n }\n}\nfinally\n{\n Close-SqlConnection\n}\n\n\n"
12+
"Octopus.Action.Script.ScriptBody": "# Define variables\n$connectionName = \"OctopusDeploy\"\n\n# Define functions\nfunction Get-ModuleInstalled \n{\n # Define parameters\n param(\n $PowerShellModuleName\n )\n\n # Check to see if the module is installed\n if ($null -ne (Get-Module -ListAvailable -Name $PowerShellModuleName))\n {\n # It is installed\n return $true\n }\n else\n {\n # Module not installed\n return $false\n }\n}\n\nfunction Install-PowerShellModule\n{\n # Define parameters\n param(\n $PowerShellModuleName,\n $LocalModulesPath\n )\n\n\t# Check to see if the package provider has been installed\n if ((Get-NugetPackageProviderNotInstalled) -ne $false)\n {\n \t# Display that we need the nuget package provider\n Write-Host \"Nuget package provider not found, installing ...\"\n \n # Install Nuget package provider\n Install-PackageProvider -Name Nuget -Force\n }\n\n\t# Save the module in the temporary location\n Save-Module -Name $PowerShellModuleName -Path $LocalModulesPath -Force\n}\n\nfunction Get-NugetPackageProviderNotInstalled\n{\n\t# See if the nuget package provider has been installed\n return ($null -eq (Get-PackageProvider -ListAvailable -Name Nuget -ErrorAction SilentlyContinue))\n}\n\nfunction Get-UserInRole\n{\n\t# Define parameters\n param ($UserHostname,\n $Username,\n $RoleHostName,\n $RoleName)\n \n\t# Execute query\n $grants = Invoke-SqlQuery \"SHOW GRANTS FOR '$Username'@'$UserHostName';\" -ConnectionName $connectionName\n\n # Loop through Grants\n foreach ($grant in $grants.ItemArray)\n {\n # Check grant\n if ($grant -eq \"GRANT $RoleName TO '$Username'@'$UserHostName'\")\n {\n # They're in the group\n return $true\n }\n }\n\n # Not found\n return $false\n}\n\n# Define PowerShell Modules path\n$LocalModules = (New-Item \"$PSScriptRoot\\Modules\" -ItemType Directory -Force).FullName\n$env:PSModulePath = \"$LocalModules$([System.IO.Path]::PathSeparator)$env:PSModulePath\"\n$PowerShellModuleName = \"SimplySql\"\n\n# Set secure protocols\n[System.Net.ServicePointManager]::SecurityProtocol = [System.Net.ServicePointManager]::SecurityProtocol -bor [Net.SecurityProtocolType]::Tls11 -bor [System.Net.SecurityProtocolType]::Tls12\n\n# Check to see if SimplySql module is installed\nif ((Get-ModuleInstalled -PowerShellModuleName $PowerShellModuleName) -ne $true)\n{\n # Tell user what we're doing\n Write-Output \"PowerShell module $PowerShellModuleName is not installed, downloading temporary copy ...\"\n\n # Install temporary copy\n Install-PowerShellModule -PowerShellModuleName $PowerShellModuleName -LocalModulesPath $LocalModules\n}\n\n# Display\nWrite-Output \"Importing module $PowerShellModuleName ...\"\n\n# Check to see if it was downloaded\nif ((Test-Path -Path \"$LocalModules\\$PowerShellModuleName\") -eq $true)\n{\n\t# Use specific location\n $PowerShellModuleName = \"$LocalModules\\$PowerShellModuleName\"\n}\n\n# Declare initial connection string\n$connectionString = \"Server=$addMariaDBServerName;Port=$addMariaDBServerPort;\"\n\n# Update the connection string based on authentication method\nswitch ($mariaDbAuthenticationMethod) {\n \"awsiam\" {\n # Region is part of the RDS endpoint, extract\n $region = ($addMariaDBServerName.Split(\".\"))[2]\n\n Write-Host \"Generating AWS IAM token ...\"\n $addLoginPasswordWithAddRoleRights = (aws rds generate-db-auth-token --hostname $addMariaDBServerName --region $region --port $addMariaDBServerPort --username $addLoginWithAddRoleRights)\n \n # Append remaining portion of connection string\n $connectionString += \";Uid=$addLoginWithAddRoleRights;Pwd=`\"$addLoginPasswordWithAddRoleRights`\";\"\n\n break\n }\n \"usernamepassword\" {\n # Append remaining portion of connection string\n $connectionString += \";Uid=$addLoginWithAddRoleRights;Pwd=`\"$addLoginPasswordWithAddRoleRights`\";\"\n \n break \n }\n \"windowsauthentication\" {\n # Append remaining portion of connection string\n $connectionString += \";IntegratedSecurity=yes;Uid=$addLoginWithAddRoleRights;\"\n\n break\n }\n}\n\n# Import the module\nImport-Module -Name $PowerShellModuleName\n\ntry\n{\n # Connect to MySQL\n Open-MySqlConnection -ConnectionString $connectionString -ConnectionName $connectionName\n\n # See if database exists\n $userInRole = Get-UserInRole -UserHostname $addUserHostname -Username $addUsername -RoleName $addRoleName\n\n if ($userInRole -eq $false)\n {\n # Create database\n Write-Output \"Adding user $addUsername@$addUserHostName to role $addRoleName ...\"\n $executionResults = Invoke-SqlUpdate \"GRANT $addRoleName TO '$addUsername'@'$addUserHostName';\" -ConnectionName $connectionName\n\n # See if it was created\n $userInRole = Get-UserInRole -UserHostname $addUserHostname -Username $addUsername -RoleName $addRoleName\n \n # Check array\n if ($userInRole -eq $true)\n {\n # Success\n Write-Output \"$addUserName@$addUserHostName added to $addRoleName successfully!\"\n }\n else\n {\n # Failed\n Write-Error \"Failure adding $addUserName@$addUserHostName to $addRoleName!\"\n }\n }\n else\n {\n \t# Display message\n Write-Output \"User $addUsername@$addUserHostName is already in role $addRoleName\"\n }\n}\nfinally\n{\n if ((Test-Connection -ConnectionName $connectionName) -eq $true)\n {\n Close-SqlConnection -ConnectionName $connectionName\n }\n}\n\n\n"
1313
},
1414
"Parameters": [
1515
{
@@ -97,9 +97,9 @@
9797
"LastModifiedBy": "coryreid",
9898
"StepPackageId": "Octopus.Script",
9999
"$Meta": {
100-
"ExportedAt": "2022-07-12T19:52:36.677Z",
101-
"OctopusVersion": "2022.3.2617-hotfix.4278",
102-
"Type": "ActionTemplate"
100+
"ExportedAt": "2026-02-19T01:10:27.925Z",
101+
"OctopusVersion": "2025.4.10425",
102+
"Type": "ActionTemplate"
103103
},
104104
"Category": "mariadb"
105105
}

0 commit comments

Comments
 (0)