Dónal
Dónal

Reputation: 187529

How to create a custom environment in Grails?

grails.util.Environment, defines a number of preconfigured environments

When running a Grails command, the environment to use can be specified using a -Denv flag, e.g. grails run-app -Denv=test. You can also specify a block of code that is specific to a certain environment using closures such as:

environments {
    production {
        grails.serverURL = "http://www.changeme.com"
    }
    development {
        grails.serverURL = "http://localhost:8080/${appName}"
    }
    test {
        grails.serverURL = "http://localhost:8080/${appName}"
    }
}

These environment-specific closures can be used in Bootstrap.groovy and Config.groovy, are there other places?

Also, is it possible for me to define my own environment, e.g. PRE_PRODUCTION, such that it will work with the closures above and the -Denv flag?

Finally, can the CUSTOM environment be used with the -Denv flag?

Upvotes: 13

Views: 8296

Answers (3)

Aleksander Rezen
Aleksander Rezen

Reputation: 927

-Dgrails.env=pre_production

More here in the Grails documentation for configuration environments

Upvotes: 1

tim_yates
tim_yates

Reputation: 171084

These environment-specific closures can be used in Bootstrap.groovy and Config.groovy, are there other places?

I don't think so... For other places, you would need to use the Generic Per Environment Execution block

Environment.executeForCurrentEnvironment {
    production {
        // do something in production
    }
    development {
        // do something only in development
    }
    pre_production {
        // do something for your custom environment
    }
}

Also, is it possible for me to define my own environment, e.g. PRE_PRODUCTION, such that it will work with the closures above and the -Denv flag?

Yeah, you should be able to just declare -Dgrails.env=pre_production and include the pre_production block in Bootstrap.groovy or Config.groovy (or a custom grails.util.Environment block as above)

edit

As you can see in the Grails source for Environment, this sort of custom environment will enumerate to Environment.CUSTOM, and then in the Environment.executeForCurrentEnvironment block, it will check against CUSTOM, and the name of the custom environment

Upvotes: 17

Ken Liu
Ken Liu

Reputation: 22914

If you create a custom environment, you can use it anywhere that the environments {} block is used. For example, in addition to Bootstrap.groovy and Config.groovy, you can also use it in DataSource.groovy and even other Config files like Searchable.groovy.

Also, I believe

Environment.currentEnvironment.name will return 'pre_production' in your case.

Upvotes: 4

Related Questions