Adding support for dotenv using the -c config file option #1236

phillipsharring · 2017-11-05T11:54:33Z

Idea

josegonzalez/dotenv is required from composer.json. The 2.* version was preferred to have consistency with the cakephp/app composer requirements.
And .env.example file is included with example config variables. This would be copied to .env and edited by the developer
A phinx.config.php.dist file is included with an example config array. This would be copied to phinx.config.php and edited by the developer to include config arrays for various environments, along with the default database config. This file references the getenv() function, so the values are read from .env. The array keys in this config file are the same as in phinx.yml.
.gitignore has been updated to include .env and *.config.php files. The name .env is a standard name for the dotenv package. The phinx.config.php file could be named and placed anywhere. The .config.php extension is just a suggestion to make ignoring the config files easier. This file could be phinx.config.php in the root, or configs/phinx.config.php or anywhere, really.

Usage

When running phinx at the command line, the -c or --configuration flag is used and the value is pointed at the phinx.config.php file, like so:

$ ./bin/phinx migrate  -e development -c phinx.config.php

The josegonzalez\Dotenv\Loader class is only loaded in the configuration file, so if the configuration file is not used, that class won't be loaded.

Again, the naming of the config file is merely a suggestion.

Note: Correct me if I'm wrong, but I don't think this needs any tests, since loading a config file is already tested. If it needs tests, I'll add them.

…suggestion

codecov-io · 2017-11-05T11:59:21Z

Codecov Report

Merging #1236 into master will decrease coverage by 0.22%.
The diff coverage is n/a.

@@             Coverage Diff              @@
##             master    #1236      +/-   ##
============================================
- Coverage     74.84%   74.62%   -0.23%     
- Complexity        0     1965    +1965     
============================================
  Files            35       54      +19     
  Lines          4783     5817    +1034     
============================================
+ Hits           3580     4341     +761     
- Misses         1203     1476     +273

Impacted Files	Coverage Δ	Complexity Δ
src/Phinx/Db/Adapter/TimedOutputAdapter.php	`18.88% <0%> (-34.72%)`	`46% <0%> (+46%)`
src/Phinx/Db/Adapter/MysqlAdapter.php	`90.04% <0%> (-8.68%)`	`221% <0%> (+221%)`
src/Phinx/Db/Adapter/AdapterWrapper.php	`61.6% <0%> (-4.8%)`	`53% <0%> (+53%)`
src/Phinx/Db/Adapter/PdoAdapter.php	`87.72% <0%> (-4.3%)`	`90% <0%> (+90%)`
src/Phinx/Migration/AbstractMigration.php	`96.1% <0%> (-3.9%)`	`35% <0%> (+35%)`
src/Phinx/Db/Table/Column.php	`85.21% <0%> (-3.2%)`	`48% <0%> (+48%)`
src/Phinx/Migration/Manager.php	`88.04% <0%> (-2.28%)`	`144% <0%> (+144%)`
src/Phinx/Db/Adapter/PostgresAdapter.php	`92.44% <0%> (-1.31%)`	`223% <0%> (+223%)`
src/Phinx/Db/Adapter/AbstractAdapter.php	`79.68% <0%> (-0.65%)`	`26% <0%> (+26%)`
src/Phinx/Db/Adapter/SqlServerAdapter.php	`0% <0%> (ø)`	`190% <0%> (+190%)`	⬆️
... and 29 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update f3f3a0a...435210f. Read the comment docs.

ADmad · 2017-11-05T18:58:30Z

composer.json

@@ -27,7 +27,8 @@
        "php": ">=5.4",
        "symfony/console": "~2.8|~3.0|~4.0",
        "symfony/config": "~2.8|~3.0|~4.0",
-        "symfony/yaml": "~2.8|~3.0|~4.0"
+        "symfony/yaml": "~2.8|~3.0|~4.0",
+        "vlucas/phpdotenv": "^2.4"


The cakephp skeleton app uses josegonzalez/dotenv for providing dotenv support. While phinx is standalone lib it would be better if projects under the cakephp family used same external libs when possible.

Good idea. I didn't know that. I'll change this to use the josegonzalez/dotenv library soon today.

I made this change. Went with "2.*" to be consistent with cakephp.

…stent with cakephp

dereuromark · 2017-11-06T15:36:06Z

composer.json

@@ -28,7 +28,7 @@
        "symfony/console": "~2.8|~3.0|~4.0",
        "symfony/config": "~2.8|~3.0|~4.0",
        "symfony/yaml": "~2.8|~3.0|~4.0",
-        "vlucas/phpdotenv": "^2.4"
+        "josegonzalez/dotenv": "2.*"


Why not semver?

I picked this version to be consistent with the version used in cakephp/app.

chinpei215 · 2017-12-08T09:19:34Z

Relates to #1085

dereuromark · 2018-03-01T20:13:15Z

Looks like we can move forward once the conflict is resolved 👍

dereuromark · 2018-03-01T21:47:29Z

.gitignore

@@ -36,3 +36,9 @@ phpunit.xml

 # sqlite test database
 phinx_testing.sqlite3
+
+# ignore dotenv .env file
+.env


why is this needed? shouldnt this only be relevant for project's config files, not for inside vendor?

The dotenv file (which is a config file) is typically placed in the root, and is ignored, because it will most likely be different in every environment an application is deployed to.

The .env.example is committed to give people a starting point. The naming of this file is also fairly standard across various project.

I'm not sure what you're asking about the vendor directory.

vendor/cakephp/phinx/.gitignore => this file
How does that relate to .env files that are in root dir?

Does this PR create a tmp .env file here in the plugin directly for testing etc?

This is for development of the project. if someone is working with phinx directly and using .env files, then this is useful for them not accidentally committing local items.

The bit where cakephp puts it in a config directory is kinda silly - but hey, we listen to kooks all the time!

As far as users ignoring it in their projects, we should almost certainly just document that the file should be gitignored as a best practice.

Sounds good.

dereuromark · 2018-03-01T21:48:05Z

composer.json

@@ -28,7 +28,8 @@
        "php": ">=5.4",
        "symfony/console": "^2.8|^3.0|^4.0",
        "symfony/config": "^2.8|^3.0|^4.0",
-        "symfony/yaml": "^2.8|^3.0|^4.0"
+        "symfony/yaml": "^2.8|^3.0|^4.0",
+        "josegonzalez/dotenv": "2.*"


Does anyone think this should be require-dev as optional one for those that do not use/want it?

The migrations will probably be run in every environment, not just while developing, right? In which case, I think this should be a requirement, not a dev requirement. Just my 2 cents but I maybe wrong in my understanding.

A dev requirement (along with suggest text) means that the functionality is there but dormant.
Once you require it in your root level (project application), it then becomes a real functionality.
So no, this should be up to the dev IMO. Along with a documentation on how to enable this of course.

dereuromark · 2018-03-01T22:14:51Z

phinx.config.php.dist

@@ -0,0 +1,38 @@
+<?php
+
+// copy this file to phinx.config.php, or your preferred name/location


Should we add the note here? composer require ... ?

We can probably add a note when installing the library somehow, though not sure where the best place for that would be.

josegonzalez · 2018-03-04T17:21:46Z

composer.json

@@ -33,7 +33,8 @@
    "require-dev": {
        "phpunit/phpunit": "^4.8.35|^5.7|^6.5",
        "sebastian/comparator": ">=1.2.3",
-        "cakephp/cakephp-codesniffer": "^3.0"
+        "cakephp/cakephp-codesniffer": "^3.0",
+        "josegonzalez/dotenv": "2.*"


This can be 3.x.

josegonzalez · 2018-03-04T17:22:40Z

Needs docs.

josephrace · 2018-04-24T11:38:25Z

phinx.config.php.dist

+    'environments' => [
+        'default_migration_table' => 'phinxlog',
+        'default_database' => getenv('APP_ENV'),
+        'develop' => [


I think this should match the APP_ENV value in .env.example - "development"

Good catch. Thanks!

williamdes

🏓

othercorey · 2020-05-08T20:44:14Z

Closing due to no activity.

Phillip Harrington added 2 commits November 5, 2017 00:25

Adding support for dotenv using the -c config file option

46e69e0

Adding a couple of comments + .env vars specific to the APP_ENV as a …

3d333b2

…suggestion

A couple of quick edits

624609d

ADmad reviewed Nov 5, 2017

View reviewed changes

Phillip Harrington added 2 commits November 6, 2017 10:29

prefering josegonzalez/dotenv instead of vlucas/phpdotenv to be consi…

a1c0235

…stent with cakephp

adding example usage w/ josegonzalez/dotenv code

7ccb5b1

dereuromark reviewed Nov 6, 2017

View reviewed changes

dereuromark added the enhancement label Nov 6, 2017

phillipsharring mentioned this pull request Mar 1, 2018

Support dotenv files #558

Closed

This was referenced Mar 1, 2018

Support .env environment variables... #845

Closed

allow symfony dotenv external parameters style in config #1085

Closed

Merge branch 'master' into master

1e54ce9

dereuromark reviewed Mar 1, 2018

View reviewed changes

Moving dotenv to require-dev

4d6628b

dereuromark reviewed Mar 1, 2018

View reviewed changes

dereuromark assigned josegonzalez Mar 1, 2018

josegonzalez reviewed Mar 4, 2018

View reviewed changes

josephrace reviewed Apr 24, 2018

View reviewed changes

Phillip Harrington added 2 commits October 22, 2018 11:13

making this key match the .env file

bad4b8e

Merge branch 'master' of github.com:philsown/phinx

435210f

lorenzo self-assigned this Oct 22, 2018

ravage84 added the feature label Oct 30, 2018

williamdes approved these changes Jan 13, 2020

View reviewed changes

othercorey closed this May 8, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adding support for dotenv using the -c config file option #1236

Adding support for dotenv using the -c config file option #1236

phillipsharring commented Nov 5, 2017 •

edited

Loading

codecov-io commented Nov 5, 2017 •

edited by codecov bot

Loading

ADmad Nov 5, 2017 •

edited

Loading

phillipsharring Nov 5, 2017

phillipsharring Nov 6, 2017

dereuromark Nov 6, 2017

phillipsharring Nov 6, 2017

chinpei215 commented Dec 8, 2017

dereuromark commented Mar 1, 2018

dereuromark Mar 1, 2018

phillipsharring Mar 1, 2018

dereuromark Mar 1, 2018 •

edited

Loading

josegonzalez Mar 4, 2018

dereuromark Mar 4, 2018

dereuromark Mar 1, 2018

phillipsharring Mar 1, 2018

dereuromark Mar 1, 2018

phillipsharring Mar 1, 2018

phillipsharring Mar 1, 2018

dereuromark Mar 1, 2018

josegonzalez Mar 4, 2018

josegonzalez Mar 4, 2018

josegonzalez commented Mar 4, 2018

josephrace Apr 24, 2018

phillipsharring Oct 22, 2018

williamdes left a comment

othercorey commented May 8, 2020

		@@ -0,0 +1,38 @@
		<?php

		// copy this file to phinx.config.php, or your preferred name/location

Adding support for dotenv using the -c config file option #1236

Adding support for dotenv using the -c config file option #1236

Conversation

phillipsharring commented Nov 5, 2017 • edited Loading

Idea

Usage

codecov-io commented Nov 5, 2017 • edited by codecov bot Loading

Codecov Report

ADmad Nov 5, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

chinpei215 commented Dec 8, 2017

dereuromark commented Mar 1, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dereuromark Mar 1, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

josegonzalez commented Mar 4, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

williamdes left a comment

Choose a reason for hiding this comment

othercorey commented May 8, 2020

phillipsharring commented Nov 5, 2017 •

edited

Loading

codecov-io commented Nov 5, 2017 •

edited by codecov bot

Loading

ADmad Nov 5, 2017 •

edited

Loading

dereuromark Mar 1, 2018 •

edited

Loading