-
Notifications
You must be signed in to change notification settings - Fork 38
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
2dab0ff
commit 2500dd4
Showing
3 changed files
with
235 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| { | ||
| "commandDescription": "Clean Profile by removing permissions stored on Permission Set" | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,190 @@ | ||
| import { flags, SfdxCommand } from '@salesforce/command'; | ||
| import { JsonArray, JsonMap } from '@salesforce/ts-types'; | ||
| import { Messages, SfdxProjectJson, SfdxError } from '@salesforce/core'; | ||
| import * as fs from 'fs'; | ||
| import * as path from 'path'; | ||
|
|
||
| const util = require('util'); | ||
| const xml2js = require('xml2js'); | ||
|
|
||
| // Initialize Messages with the current plugin directory | ||
| Messages.importMessagesDirectory(__dirname); | ||
|
|
||
| // Load the specific messages for this file. Messages from @salesforce/command, @salesforce/core, | ||
| // or any library that is using the messages framework can also be loaded this way. | ||
| const messages = Messages.loadMessages('texei-sfdx-plugin', 'profile-clean'); | ||
|
|
||
| const defaultProfileFolder = 'force-app/main/default/profiles'; | ||
|
|
||
| export default class Clean extends SfdxCommand { | ||
|
|
||
| public static description = messages.getMessage('commandDescription'); | ||
|
|
||
| public static examples = [ | ||
| '$ texei:profile:clean -k layoutAssignments,recordTypeVisibilities', | ||
| '$ texei:profile:clean -p custom-sfdx-source-folder/main/profiles', | ||
| '$ texei:profile:clean -p custom-sfdx-source-folder/main/profiles,source-folder-2/main/profiles/myAdmin.profile-meta.xml' | ||
| ]; | ||
|
|
||
| protected static flagsConfig = { | ||
| keep: flags.string({ char: 'k', required: false, description: 'comma-separated list of profile node permissions that need to be kept. Default: layoutAssignments,loginHours,loginIpRanges,custom,userLicense' }), | ||
| path: flags.string({ char: 'p', required: false, description: 'comma-separated list of profiles, or path to profiles folder. Default: default package directory' }) | ||
| }; | ||
|
|
||
| // Comment this out if your command does not require an org username | ||
| protected static requiresUsername = false; | ||
|
|
||
| // Comment this out if your command does not require a hub org username | ||
| protected static requiresDevhubUsername = false; | ||
|
|
||
| // Set this to true if your command requires a project workspace; 'requiresProject' is false by default | ||
| protected static requiresProject = false; | ||
|
|
||
| public async run(): Promise<any> { | ||
|
|
||
| let cleanResult = []; | ||
|
|
||
| // TODO: Keep default recordTypeVisibilities & applicationVisibilities like in skinnyprofile:retrieve | ||
| const defaultKeep = ['layoutAssignments','loginHours','loginIpRanges','custom','userLicense']; | ||
| const nodesToKeep = this.flags.keep ? this.flags.keep : defaultKeep; | ||
| let profilesToClean = []; | ||
|
|
||
| // Get profiles files path | ||
| if (this.flags.path) { | ||
|
|
||
| // If path was provided as a flag use it/them | ||
| const paths = this.flags.path.split(','); | ||
|
|
||
| for (const currentPath of paths) { | ||
|
|
||
| if (currentPath.endsWith('.profile-meta.xml')) { | ||
| // Well, this should be a profile | ||
| // Otherwise you have a weird folder naming convention, you should probably stop this | ||
| profilesToClean.push(currentPath); | ||
| } | ||
| else { | ||
| // Flag provided value doesn't end like a Profile source metadata | ||
| // Expect it's a folder | ||
| profilesToClean = await this.getProfilesInPath(currentPath); | ||
| } | ||
| } | ||
| } | ||
| else { | ||
| // Else look in the default package directory | ||
| const defaultPackageDirectory = await this.getDefaultPath(); | ||
| profilesToClean = await this.getProfilesInPath(defaultPackageDirectory); | ||
| } | ||
|
|
||
| if (profilesToClean.length == 0) { | ||
| this.ux.log('No Profile found :('); | ||
| } | ||
|
|
||
| // Promisify functions | ||
| const readFile = util.promisify(fs.readFile); | ||
|
|
||
| for (const profilePath of profilesToClean) { | ||
|
|
||
| // Generate path | ||
| const filePath = path.join( | ||
| process.cwd(), | ||
| profilePath | ||
| ); | ||
|
|
||
| // Read data file | ||
| const data = await readFile(filePath, 'utf8'); | ||
|
|
||
| // Parsing file | ||
| // According to xml2js doc it's better to recreate a parser for each file | ||
| // https://www.npmjs.com/package/xml2js#user-content-parsing-multiple-files | ||
| var parser = new xml2js.Parser(); | ||
| const parseString = util.promisify(parser.parseString); | ||
| const profileJson = await parseString(data); | ||
|
|
||
| // Removing unwanted nodes | ||
| for (const nodeKey in profileJson.Profile) { | ||
| if (profileJson.Profile.hasOwnProperty(nodeKey)) { | ||
| if (!nodesToKeep.includes(nodeKey)) { | ||
| delete profileJson.Profile[nodeKey]; | ||
| } | ||
| } | ||
| } | ||
|
|
||
| // Building back as an xml | ||
| const builder = new xml2js.Builder(); | ||
| var xmlFile = builder.buildObject(profileJson); | ||
|
|
||
| // Writing back to file | ||
| await fs.writeFile(filePath, xmlFile, 'utf8', function (err) { | ||
| if (err) { | ||
| throw new SfdxError(`Unable to write Products file at path ${filePath}: ${err}`); | ||
| } | ||
| }); | ||
|
|
||
| this.ux.log(`Profile cleaned: ${profilePath}`); | ||
| cleanResult.push(profilePath); | ||
| } | ||
|
|
||
| return { profilesCleaned: cleanResult }; | ||
| } | ||
|
|
||
| private async getProfilesInPath(pathToRead: string) { | ||
| let profilesInPath = []; | ||
|
|
||
| const readDirectory = util.promisify(fs.readdir); | ||
| const filesInDir = await readDirectory(pathToRead); | ||
|
|
||
| for (const fileInDir of filesInDir) { | ||
|
|
||
| const dirOrFilePath = path.join( | ||
| process.cwd(), | ||
| pathToRead, | ||
| fileInDir | ||
| ); | ||
|
|
||
| // If it's a Profile file, add it | ||
| if (!fs.lstatSync(dirOrFilePath).isDirectory() && fileInDir.endsWith('.profile-meta.xml')) { | ||
|
|
||
| const profileFoundPath = path.join( | ||
| pathToRead, | ||
| fileInDir | ||
| ); | ||
|
|
||
| profilesInPath.push(profileFoundPath); | ||
| } | ||
| } | ||
|
|
||
| return profilesInPath; | ||
| } | ||
|
|
||
| // should probably be in a util class | ||
| private async getDefaultPath() { | ||
|
|
||
| // Look for a default package directory | ||
| const options = SfdxProjectJson.getDefaultOptions(); | ||
| const project = await SfdxProjectJson.create(options); | ||
| const packageDirectories = project.get('packageDirectories') as JsonArray || []; | ||
|
|
||
| let foundPath; | ||
| for (let packageDirectory of packageDirectories) { | ||
| packageDirectory = packageDirectory as JsonMap; | ||
|
|
||
| if (packageDirectory.path && packageDirectory.default) { | ||
|
|
||
| foundPath = path.join( | ||
| packageDirectory.path as string, | ||
| 'main', | ||
| 'default', | ||
| 'profiles' | ||
| ); | ||
| break; | ||
| } | ||
|
|
||
| // If no default package directory is found, use the vanilla default DX folder | ||
| if (!foundPath) { | ||
| foundPath = defaultProfileFolder; | ||
| } | ||
| } | ||
|
|
||
| return foundPath | ||
| } | ||
| } |