neva-dev / gradle-fork-plugin Goto Github PK

Gradle Fork Plugin - Project generator based on live archetypes (example projects) & interactive gradle.properties file generator

License: Apache License 2.0

Kotlin 93.90% Shell 6.10%

archetype template gradle gui live-archetypes password-encryption maven-archetype properties

gradle-fork-plugin's People

Contributors

Stargazers

Watchers

Forkers

mierzwid

gradle-fork-plugin's Issues

Cannot use a property if it isn't used in the "config" session

Hi,

I have a property that is used on the controller of other property, like this:

    define("baseDir") {
      defaultValue = "/default/path"
    }
    define("targetPath") {
      enabled = false
      controller {
        value = other("baseDir").value + '/' + other("artifactId").value
      }
    }

The properity "baseDir" isn't used the "config" session, just in the "properties" session.

When I try to run "fork", I get the error Property named 'baseDir' does not exist. This always happen with properties that aren't used in the "config" session. Is there any way to override this behaviour?

Regards,

Rodrigo

Make property groups/fields togglable

to be able to show/hide tab on GUI depending on other select field value
should also be respected when GUI is not running

Prompt properties to be amended in forked gradle.properties file

Imagine:

fork {
    config {
        appendPrompt "gradle.properties", ["nexusUser", "nexusPassword"]
    }
}

after forking gradle.properties will have appended

nexusUser=[userInput]
nexusPassword=[userInput]

Introduce more content manipulating actions

Imagine e.g

fork {
    config {
        cloneFiles()
        // ...
        removeLine("apply from(\"gradle/fork.gradle.kts\")", "/build.gradle.kts") // new action
        removeFile("gradle/fork.gradle.kts") // new action
        copyTemplateFile("README.MD") // will override existing
    }
}

to be able to clean up forking configuration (fork will not be forkable)

Conditionally require properties to be specified

E.g when when some checkbox or select have approprate value, then toggle other fields visibility (and mandatory / mark required or not)

NPE in file chooser

Caused by: com.neva.gradle.fork.ForkException: Fork properties GUI dialog cannot be opened!
Please run 'sh gradlew --stop' then try again.
Ultimately run command with '--no-daemon' option.
        at com.neva.gradle.fork.gui.PropertyDialog$Companion.make(PropertyDialog.kt:169)
        at com.neva.gradle.fork.config.Config.promptFillGui(Config.kt:166)
        at com.neva.gradle.fork.config.Config.promptFill(Config.kt:122)
        at com.neva.gradle.fork.config.Config.access$promptFill(Config.kt:21)
        at com.neva.gradle.fork.config.Config$promptedProperties$2.invoke(Config.kt:29)
        at com.neva.gradle.fork.config.Config$promptedProperties$2.invoke(Config.kt:21)
        at kotlin.SynchronizedLazyImpl.getValue(LazyJVM.kt:74)
        at com.neva.gradle.fork.config.Config.getPromptedProperties(Config.kt)
        at com.neva.gradle.fork.config.Config.validate(Config.kt:293)
        at com.neva.gradle.fork.config.Config.evaluate(Config.kt:287)
        at com.neva.gradle.fork.tasks.ConfigTask.evaluate(ConfigTask.kt:18)
        at org.gradle.internal.reflect.JavaMethod.invoke(JavaMethod.java:104)
        at org.gradle.api.internal.project.taskfactory.StandardTaskAction.doExecute(StandardTaskAction.java:49)
        at org.gradle.api.internal.project.taskfactory.StandardTaskAction.execute(StandardTaskAction.java:42)
        at org.gradle.api.internal.project.taskfactory.StandardTaskAction.execute(StandardTaskAction.java:28)
        at org.gradle.api.internal.AbstractTask$TaskActionWrapper.execute(AbstractTask.java:721)
        at org.gradle.api.internal.AbstractTask$TaskActionWrapper.execute(AbstractTask.java:688)
        at org.gradle.api.internal.tasks.execution.ExecuteActionsTaskExecuter$3.run(ExecuteActionsTaskExecuter.java:539)
        at org.gradle.internal.operations.DefaultBuildOperationExecutor$RunnableBuildOperationWorker.execute(DefaultBuildOperationExecutor.java:402)
        at org.gradle.internal.operations.DefaultBuildOperationExecutor$RunnableBuildOperationWorker.execute(DefaultBuildOperationExecutor.java:394)
        at org.gradle.internal.operations.DefaultBuildOperationExecutor$1.execute(DefaultBuildOperationExecutor.java:165)
        at org.gradle.internal.operations.DefaultBuildOperationExecutor.execute(DefaultBuildOperationExecutor.java:250)
        at org.gradle.internal.operations.DefaultBuildOperationExecutor.execute(DefaultBuildOperationExecutor.java:158)
        at org.gradle.internal.operations.DefaultBuildOperationExecutor.run(DefaultBuildOperationExecutor.java:92)
        at org.gradle.internal.operations.DelegatingBuildOperationExecutor.run(DelegatingBuildOperationExecutor.java:31)
        at org.gradle.api.internal.tasks.execution.ExecuteActionsTaskExecuter.executeAction(ExecuteActionsTaskExecuter.java:524)
        at org.gradle.api.internal.tasks.execution.ExecuteActionsTaskExecuter.executeActions(ExecuteActionsTaskExecuter.java:507)
        at org.gradle.api.internal.tasks.execution.ExecuteActionsTaskExecuter.access$300(ExecuteActionsTaskExecuter.java:109)
        at org.gradle.api.internal.tasks.execution.ExecuteActionsTaskExecuter$TaskExecution.executeWithPreviousOutputFiles(ExecuteActionsTaskExecuter.java:258)
        at org.gradle.api.internal.tasks.execution.ExecuteActionsTaskExecuter$TaskExecution.execute(ExecuteActionsTaskExecuter.java:247)
        at org.gradle.internal.execution.steps.ExecuteStep.lambda$execute$1(ExecuteStep.java:33)
        at org.gradle.internal.execution.steps.ExecuteStep.execute(ExecuteStep.java:33)
        at org.gradle.internal.execution.steps.ExecuteStep.execute(ExecuteStep.java:26)
        at org.gradle.internal.execution.steps.CleanupOutputsStep.execute(CleanupOutputsStep.java:63)
        at org.gradle.internal.execution.steps.CleanupOutputsStep.execute(CleanupOutputsStep.java:35)
        at org.gradle.internal.execution.steps.ResolveInputChangesStep.execute(ResolveInputChangesStep.java:49)
        at org.gradle.internal.execution.steps.ResolveInputChangesStep.execute(ResolveInputChangesStep.java:34)
        at org.gradle.internal.execution.steps.CancelExecutionStep.execute(CancelExecutionStep.java:43)
        at org.gradle.internal.execution.steps.TimeoutStep.executeWithoutTimeout(TimeoutStep.java:73)
        at org.gradle.internal.execution.steps.TimeoutStep.execute(TimeoutStep.java:54)
        at org.gradle.internal.execution.steps.CatchExceptionStep.execute(CatchExceptionStep.java:34)
        at org.gradle.internal.execution.steps.CreateOutputsStep.execute(CreateOutputsStep.java:44)
        at org.gradle.internal.execution.steps.SnapshotOutputsStep.execute(SnapshotOutputsStep.java:54)
        at org.gradle.internal.execution.steps.SnapshotOutputsStep.execute(SnapshotOutputsStep.java:38)
        at org.gradle.internal.execution.steps.CacheStep.executeWithoutCache(CacheStep.java:153)
        at org.gradle.internal.execution.steps.CacheStep.execute(CacheStep.java:67)
        at org.gradle.internal.execution.steps.CacheStep.execute(CacheStep.java:41)
        at org.gradle.internal.execution.steps.BroadcastChangingOutputsStep.execute(BroadcastChangingOutputsStep.java:49)
        at org.gradle.internal.execution.steps.StoreExecutionStateStep.execute(StoreExecutionStateStep.java:44)
        at org.gradle.internal.execution.steps.StoreExecutionStateStep.execute(StoreExecutionStateStep.java:33)
        at org.gradle.internal.execution.steps.RecordOutputsStep.execute(RecordOutputsStep.java:38)
        at org.gradle.internal.execution.steps.RecordOutputsStep.execute(RecordOutputsStep.java:24)
        at org.gradle.internal.execution.steps.SkipUpToDateStep.executeBecause(SkipUpToDateStep.java:92)
        at org.gradle.internal.execution.steps.SkipUpToDateStep.lambda$execute$0(SkipUpToDateStep.java:85)
        at org.gradle.internal.execution.steps.SkipUpToDateStep.execute(SkipUpToDateStep.java:55)
        at org.gradle.internal.execution.steps.SkipUpToDateStep.execute(SkipUpToDateStep.java:39)
        at org.gradle.internal.execution.steps.ResolveChangesStep.execute(ResolveChangesStep.java:76)
        at org.gradle.internal.execution.steps.ResolveChangesStep.execute(ResolveChangesStep.java:37)
        at org.gradle.internal.execution.steps.legacy.MarkSnapshottingInputsFinishedStep.execute(MarkSnapshottingInputsFinishedStep.java:36)
        at org.gradle.internal.execution.steps.legacy.MarkSnapshottingInputsFinishedStep.execute(MarkSnapshottingInputsFinishedStep.java:26)
        at org.gradle.internal.execution.steps.ResolveCachingStateStep.execute(ResolveCachingStateStep.java:94)
        at org.gradle.internal.execution.steps.ResolveCachingStateStep.execute(ResolveCachingStateStep.java:49)
        at org.gradle.internal.execution.steps.CaptureStateBeforeExecutionStep.execute(CaptureStateBeforeExecutionStep.java:79)
        at org.gradle.internal.execution.steps.CaptureStateBeforeExecutionStep.execute(CaptureStateBeforeExecutionStep.java:53)
        at org.gradle.internal.execution.steps.ValidateStep.execute(ValidateStep.java:74)
        at org.gradle.internal.execution.steps.SkipEmptyWorkStep.lambda$execute$2(SkipEmptyWorkStep.java:78)
        at org.gradle.internal.execution.steps.SkipEmptyWorkStep.execute(SkipEmptyWorkStep.java:78)
        at org.gradle.internal.execution.steps.SkipEmptyWorkStep.execute(SkipEmptyWorkStep.java:34)
        at org.gradle.internal.execution.steps.legacy.MarkSnapshottingInputsStartedStep.execute(MarkSnapshottingInputsStartedStep.java:39)
        at org.gradle.internal.execution.steps.LoadExecutionStateStep.execute(LoadExecutionStateStep.java:40)
        at org.gradle.internal.execution.steps.LoadExecutionStateStep.execute(LoadExecutionStateStep.java:28)
        at org.gradle.internal.execution.impl.DefaultWorkExecutor.execute(DefaultWorkExecutor.java:33)
        at org.gradle.api.internal.tasks.execution.ExecuteActionsTaskExecuter.executeIfValid(ExecuteActionsTaskExecuter.java:174)
        ... 30 more
Caused by: java.lang.NullPointerException
        at com.sun.java.swing.plaf.windows.WindowsFileChooserUI.updateUseShellFolder(WindowsFileChooserUI.java:498)
        at com.sun.java.swing.plaf.windows.WindowsFileChooserUI.installComponents(WindowsFileChooserUI.java:212)
        at com.sun.java.swing.plaf.windows.WindowsFileChooserUI.installUI(WindowsFileChooserUI.java:149)
        at com.neva.gradle.fork.gui.PropertyDialog.<init>(PropertyDialog.kt:112)
        at com.neva.gradle.fork.gui.PropertyDialog$Companion.make(PropertyDialog.kt:163)
        ... 102 more

Replace with placeholders

based on replaceAll

for handling https://github.com/Cognifide/gradle-aem-multi/blob/master/gradle/fork.gradle.kts#L103

Allow putting links in field descriptions

To simplify connecting fields with documentations

https://www.codejava.net/java-se/swing/how-to-create-hyperlink-with-jlabel-in-java-swing

Properties precedence

the last one has always-win precedence...

expected:

gradle.properties
gradle.user.properties
CMD line -Pkey=value

actual:

gradle.user.properties
gradle.properties
CMD line

actual when setting fork.override=true

gradle.properties
CMD line
gradle.user.properties

Intermittent headless exception

as a workaround simply run sh gradlew --stop then sh gradlew props and it should work again properly

Introduce predefined settings task

Imagine

sh gradlew fork -Pfork.config=properties

replaced by just

sh gradlew properties

which will use reserved in-place config named properties

Do not fail build when closing dialog

as of throwing an exception is killing daemon state / and when running next build, creating new daemon is needed.

Prompt fork properties using GUI window

In a same way as http://mrhaki.blogspot.com/2010/09/gradle-goodness-get-user-input-values.html

Rule for deleting lines between tags

as of fork config should delete forking related gradle files and contents, dedicated rules for deleting e.g

build.gradle.kts

// fork:start
fork {
    properties {
        /// this lines should not be available in forked project
    }
}
// fork:end

would be nice

Improved password encryption in fork plugin

encrypt password in cache file: build/fork/config/properties.properties
encrypt password provided in DSL as a default value only if it isn't already encrypted:
https://github.com/neva-dev/gradle-fork-plugin/blob/master/src/main/kotlin/com/neva/gradle/fork/encryption/Encryption.kt#L24

Providers for default value, control bugfix

default value should be a callback called as late as it is possible
when controller {} callback is used to assign other field value; such other field value cannot be then changed

Allow users to force a value on other properties when a condition is met

Make property groups/fields togglable

to be able to show/hide tab on GUI depending on other select field value
should also be respected when GUI is not running

Task for populating extra static properties

like appending to gradle.properties file (but using a separate file to avoid making VCS change)

sh gradlew initProps -PinitProp1=val1 etc

Autodecrypt passwords specified in own / user specific properties file

Make Fork decrypt password, so other plugins like GAP don't have to use forkProps extension to pass properties.

When fork generates properties file with password encrypted it adds fp: prefix to them:

fileTransfer.sftp.user=username
fileTransfer.sftp.password={fp:nWVIC40MKSf2ZasfflkOXA==}

knowing the peb template it can decode values on the fly, so build script author don't have to pass through in the build file:

aem {
    fileTransfer {
        sftp {
            user = forkProps["fileTransfer.sftp.user"]
            password = forkProps["fileTransfer.sftp.password"]
        }
    }
}

Make smaller 'Pick a path button'

Bubble up property validation message

just "missing or invalid" message is too generic. if possible propagate detailed error message to the exception so be able to easier demystify problems

Use more rich format to store properties internally

e.g to allow implementing multi-checkbox, storing e.g lists in properties file is problematic.

maybe instead of using *.properties more verbose format like *.yml might be useful to be used.

CMD line should override properties in gradle.user.properties file

maybe just "define if not defined" condition need to be added

Post-fork commands

Hi,

Is it possible to execute a command line script inside the forked app's folder, like a git repo initialization? I could do something like fork.finalizedBy gitInit but I don't know how to get the generated folder path.

I also tried the following in 'fork.config' but it didn't work:

action(Action { Runtime.getRuntime().exec("git init") })

Could you help me?

Thanks in advance. Regards!

Do not display GUI if there is no properties

Regenerate user properties file on template update

when tpl file has been changed then there is usually a need to regenerate gradle.user.properties file.

how about regenerating that file automatically e.g when requireProps is called...

Introduce `-Pfork.execute` flag

which will be useful for cases when changes from updated TPL need to be applied without updating values already saved on GUI dialog

Treat properties with 'Token' suffix as passwords

File in use exception after filling properties

> Task :props FAILED
Build failure
Execution failed for task ':props'.

FAILURE: Build failed with an exception.

* What went wrong:
Execution failed for task ':props'.
> java.nio.file.FileSystemException: C:\Users\krystian.panek\Projects\gradle-aem-multi\gradle.user.properties: Proces nie mo▒e uzyska▒ dost▒pu do pliku, poniewa▒ jest on u▒ywany przez inny proces.

why? when project is open in intellij, it could prevent file saving of 'gradle.user.properties' occassionally

to fix it:

a) close IntelliJ, rerun gradlew props
b) run gradlew --stop then rerun gradlew props

this affects only Windows machines

any ideas how to fix / avoid it?

Providers for default value, control bugfix

default value should be a callback called as late as it is possible
when controller {} callback is used to assign other field value; such other field value cannot be then changed

Encrypt password properties

Design :

implement and use obfuscated (by proguard https://www.guardsquare.com/en/products/proguard ) library that will return hashed encryption passphrase basing on project specific gradle build model details (do not share unobfuscated source code on GH)
provide method fork.property(name) that will just proxy project.findProperty(name) or if property is encrypted (basing on definition #9 #5 ) decrypted value instead of as is (logic similar to https://github.com/etiennestuder/gradle-credentials-plugin ; encrypter with passphrase based on 1) )

sample usage

plugins {
    id ("com.neva.fork")
}

repositories {
    maven { 
        url = uri("http://nexus.xxx.com/groups/private")
        username = fork.prop("nexus.username")
        password = fork.prop("nexus.password")
    }
}

Ability to select dir not only file in pick a path

Template engine password filter

Consider impl {{ somePassword | password }} filter that will decrypt the value only intentionally

Extract the core features to a Gradle independent library

I'm currently using Fork Plugin but I'd like to use it without Gradle, embedded on a custom application. I think I'll extract and adapt the code I need from this repository but I was wondering if others share the same need.

Task `clean` should not remove fork properties cache

Allow users to clear other properties when a condition is met

Ability to define default values for properties defined multiple times

There is no way to elegantly define default value for e.g projectGroup. Consider new DSL:

fork {
    config {
        cloneFiles()
        moveFiles([
                "/com/company/x/example": "/{{projectGroup|substitute('.', '/')}}/{{projectName}}",
                "/example": "/{{projectName}}"
        ])
        replaceContents([
                "com.company.x.example": "{{projectGroup}}.{{projectName}}",
                'com.company.x': "{{projectGroup}}",
                "Example": "{{projectLabel}}",
                "example": "{{projectName}}",
        ])
        defineProperties([
                property "projectGroup", "com.company.x"
                property "projectLabel", "Example",
                property "projectName", "example" 

                /* below mostly expected :)
                property "projectName",  { 
                    defaultValue = "example"
                    validator = { !it.value('projectGroup').contains(it.value)) } 
                }
                */
               property "libVersion", { // that property will be used in some template file, not in above sections directly
                    defaultValue = "1.0.0"
                    radio ['1.0.0', '2.00', '3.0.0''] // GUI control type 'radio' instead of default 'textfield'
                    required()
                }
        ])
    }
}

Gradle Fork Plugin is not available

The dl.bintray.com repository is not active any more, please reference this page in docs.

Check README.md file.

Define a task validating existence of user-specific properties file

Imagine

tasks {
    instanceSetup {
        dependsOn("propsCheck")
    }
}

right now, after cloning a project, we could forget about generating user-specific configuration to run some task

maybe we could introduce separate plugin e.g com.neva.fork.props.check with will allow to run only tasks and props task at first, then after generating gradle.user.properties all others...

Rendering dialog fields in groups / tabs

Especially when there is too many properties, then grouping them by tabs will cause that windows will be smaller / nicer