Allow adding Chassis as a Composer dependancy #583

kasparsd · 2018-09-22T08:57:07Z

Fixes #481.

Objectives

Allow adding Chassis to any project as a Composer or npm dependancy:

composer require --dev chassis/chassis

with only two extra files:

Vagrantfile that loads the Chassis Vagrantfile and specifies the project root as the directory that contains the configuration file:

ENV['CHASSIS_CWD'] = File.dirname(__FILE__)
load "vendor/chassis/chassis/Vagrantfile"

and config.local.yaml that adds the project directory as a plugin or theme to Chassis:

hosts:
  - composer.local

synced_folders:
  .: /vagrant/content/plugins/this-plugin

Suggested Changes

Always map Chassis root directory to the /vagrant directory inside the Vagrant machine.
Map the Vagrant working directory (directory of Vagrantfile) or ENV['CHASSIS_CWD'] (see discussion) to /chassis inside Vagrant.
Always look for config override files config.local.yaml in /chassis.

By default, the Vagrant working directory is the same as the Chassis root directory so /chassis will map to to the same place as /vagrant. However, in case of adding Chassis via Composer or npm, the /chassis directory will map to the root of that project while /vagrant will still map to the root of the Chassis core.

Settings for paths in config.local.yaml are still resolved relative to the Chassis root directory, in order to preserve the default lookups for the wp and contents directories.

Tasks

All Chassis system files should be loaded relative to the Chassis root directory.
Allow config.yaml overrides in a directory outside the Chassis root.

Examples

Example: Plugin Development

See https://github.com/wpsh/chassis-composer-demo/tree/dev-481

Example of a plugin with an included development environment via Composer.
Installs the Query Monitor plugin for development purposes.
Uses synced_folders to define the project root directory as a plugin mapped to /chassis/content/plugins/this-plugin.

git clone https://github.com/wpsh/chassis-composer-demo.git
cd chassis-composer-demo
git checkout dev-481
composer install
vagrant up

Example: WP Core Development

See https://github.com/wpsh/chassis-composer-demo/tree/dev-481-wp-develop

Adds wordpress-develop as a Composer dependancy.

Known Issues

None.

Notes

See: https://kaspars.net/blog/wordpress/wordpress-environment-composer

BronsonQuick · 2018-09-22T09:05:29Z

Thanks so much for starting work on this @kasparsd! Let me know when you're happy for one of us to test it out for you.

Which can be the same in some instances

Introduce chassis_config_dir which defaults to Chassis root but can be configured to anything

kasparsd · 2018-09-24T11:47:52Z

Vagrantfile

@@ -86,19 +92,19 @@ Vagrant.configure("2") do |config|
 		CONF['apt_mirror'].to_s,
 		CONF['database']['has_custom_prefix'] ? "" : "check_prefix"
 	]
-	config.vm.provision :shell, :path => "puppet/preprovision.sh", :args => preprovision_args
+	config.vm.provision :shell, :path => File.expand_path("puppet/preprovision.sh", base_path), :args => preprovision_args


For relative paths Vagrant uses the current working directory PWD so we need to be explicit about where the provision scripts are located.

kasparsd · 2018-09-24T11:50:07Z

Vagrantfile

 		puppet.manifest_file  = "development.pp"

 		# Broken due to https://github.com/mitchellh/vagrant/issues/2902
 		## puppet.module_path    = module_paths
 		# Workaround:
-		machine_rel_module_paths = module_paths.map { |rel_path| "/vagrant/" + rel_path }
+		machine_rel_module_paths = module_paths.map { |rel_path| "/chassis/" + rel_path }


Modules are always inside the Chassis root directory. Did Chassis ever support loading modules from outside the Chassis root?

kasparsd · 2018-09-24T12:08:10Z

Vagrantfile

 # Check that submodules have been loaded
-if not File.exist?(File.join(File.dirname(__FILE__), "puppet", "modules", "apt", ".git"))
+if not File.exist?(File.join(chassis_dir, "puppet", "modules", "apt", ".git"))


File.dirname(__FILE__) was repeated in several places so we introduce chassis_dir.

Chassis/Chassis#583

kasparsd · 2018-09-24T13:24:26Z

@BronsonQuick @rmccue This is ready for code review and testing. Please see the "Demo" section in the description of the pull request for how to test this.

Use relative path for the Chassis root sync definition

kasparsd · 2018-10-06T07:14:31Z

@BronsonQuick This is ready for code review and testing. See the Examples section in the description for two sample repositories.

rmccue · 2018-10-08T18:22:54Z

@kasparsd I think you've potentially mixed two different directories here? Extensions/Puppet/etc should always be at /vagrant/extensions, /vagrant/puppet, etc, I don't think we want to change that. (We could potentially change to always mount root at /chassis though.)

Perhaps I'm missing what this gains over the existing VAGRANT_CWD?

kasparsd · 2018-10-11T06:57:34Z

@rmccue Thanks for reviewing the pull request!

Extensions/Puppet/etc should always be at /vagrant/extensions, /vagrant/puppet, etc.

Just to confirm -- could we mount Chassis root at /vagrant and the project root at /chassis? I'll look into this.

Perhaps I'm missing what this gains over the existing VAGRANT_CWD?

I created this sample project to illustrate the issue.

With VAGRANT_CWD=vendor/chassis/chassis vagrant up it looks for config overrides config.local.yaml inside the Chassis root directory vendor/chassis/chassis instead of the project directory. This is due to this lookup logic which assumes that all config overrides are at the Chassis root @@dir.

The suggested fix is to introduce a @@config_dir variable which can be set to anything via the CHASSIS_CWD environmental variable. We need some way of telling Chassis that it should read the config override from another directory.

kasparsd · 2018-10-11T07:31:37Z

.gitignore

 .DS_Store
 .idea
 config.local.yaml
 /.wp-cli
 /wp-cli.local.yml
-/extensions


This directory is actually being tracked as it contains the example extension.

This is intentional; gitignore simply ensures untracked files are not shown, but still allows files to be committed within it. Chassis requires the example extension for technical reasons (plus it's useful), but we don't want to show any other files in that directory.

@rmccue Right, so we want to keep tracking /extensions directory and the example directory inside it while ignoring everything else. This is why I suggest we introduce a .gitignore in the extensions directorythat only tracks theexample` directory and excludes everything else.

Currently it is a bit confusing to see the extensions directory ignored in the .gitignore but actually tracked in the repository. I think it only works because it was once tracked and later ignored in 9b49b56. Per docs:

Files already tracked by Git are not affected.

and

To stop tracking a file that is currently tracked, use git rm --cached.

So if the intention is to track the sample extension extensions/sample, I suggest we clarify that by updating the .gitignore files.

I'm totally OK with not changing this, if you prefer. Just wanted to explain the reasoning and though behind it.

kasparsd · 2018-10-11T07:32:47Z

.gitignore

@@ -6,12 +6,11 @@
 /local-config-extensions.php
 /sql-dump-*.sql
 /db-sync
-/content


We actually need this directory to exist so we add a dedicated .gitignore inside the content directory which excludes everything but itself.

This will conflict with anyone with a checked-out repository inside content, and is a blocker.

kasparsd · 2018-10-11T07:36:27Z

puppet/chassis.rb

@@ -3,6 +3,7 @@

 module Chassis
 	@@dir = File.dirname(File.dirname(__FILE__))
+	@@config_dir = @@dir


This is the new config path variable used to reference the directory that contains the config overrides. Previously it was assumed that all config overrides are inside the Chassis root directory.

rmccue · 2018-10-11T07:44:34Z

.gitignore

 .DS_Store
 .idea
 config.local.yaml
 /.wp-cli
 /wp-cli.local.yml
-/extensions


This is intentional; gitignore simply ensures untracked files are not shown, but still allows files to be committed within it. Chassis requires the example extension for technical reasons (plus it's useful), but we don't want to show any other files in that directory.

rmccue · 2018-10-11T07:45:00Z

.gitignore

@@ -6,12 +6,11 @@
 /local-config-extensions.php
 /sql-dump-*.sql
 /db-sync
-/content


This will conflict with anyone with a checked-out repository inside content, and is a blocker.

rmccue · 2018-10-11T07:45:54Z

puppet/chassis.rb

-		end
+		# Set up the paths as needed
+		config["mapped_paths"] = {}
+		config["mapped_paths"]["base"] = "/vagrant"


This still appears to be using the incorrect split of base/Chassis directories?

Yeah, this is a hard one.

Currently we set the base relative to the Chassis root directory @@dir and without a base override in config.local.yaml it defaults to the Chassis root directory which is where it looks for the default wp and content directories. And per you suggestion, the core Chassis directory should be kept at /vagrant which also includes the default wp and content directories.

By default, if base is inside the Chassis root, it would map the base to /vagrant which contains the default wp and content directories provided by Chassis.

If the base in config.local.yaml is set to outside the Chassis root if not base.start_with? @@dir, it would map that base to /chassis and do the wp and content mapping relative to that /chassis directory. And with a custom base, the user is expected to configure paths to the wp and content directories.

With the Composer/npm use-case the project root directory will always be outside the Chassis directory so we need to default to the wp and contents directories provided by Chassis (under /vagrant) unless specified otherwise via the paths override.

Mapping the base to /vagrant satisfies both requirements because:

it defaults to the wp and content directories provided by Chassis even if the project root is outside the Chassis root and no paths overrides have been specified;

it looks for custom wp and content directories (relative to the Chassis root directory) only if a custom base is specified in config.local.yaml.

Finally, we now map the project root to /chassis so syncing anything to /chassis/#{path} will create new wp and content directories inside the project root.

rmccue · 2018-10-11T07:48:08Z

I wonder whether we could try and address both this issue and #581 at the same time.

What if instead of a custom environment variable for this, we instead loaded config{,.local}.yaml from the specified content directory? This would require a two-pass parse, but would be a bit nicer IMO.

kasparsd · 2018-10-11T09:44:33Z

Vagrantfile

 		puts "WARNING: Submodules may be missing, and could not automatically\ndownload them for you."
 	end

 	# Extra new line, please!
 	puts
 end

+# Ensure we have a content directory to sync.
+chassis_content_dir = File.join(chassis_dir, "content")
+Dir.mkdir(chassis_content_dir) unless File.exists?(chassis_content_dir)


@rmccue We need the content directory to exist before Vagrant can sync it to the virtual machine or it fails with the following error on the initial vagrant up:

There are errors in the configuration of this machine. Please fix the following errors and try again: vm: * The host path of the shared folder is missing: /absolute/path/to/Chassis/content

kasparsd · 2018-10-11T10:22:14Z

What if instead of a custom environment variable for this, we instead loaded config{,.local}.yaml from the specified content directory?

@rmccue This still assumes that you're running vagrant from the Chassis root directory where it finds the config.local.yaml. #583 is more supporting config.local.yaml outside the Chassis root directory.

I would like to better understand the example provided by @mikeselander:

 - /chassis (Everything Chassis)
   - config.local.yaml (Basic overrides (see full file below)
 - /content (Actual used content directory)
   - config.local.yaml (Installation-specific overrides)
 - /wordpress (WordPress used on platform)

What is the reason behind having two config.local.yaml files? How are they different?

kasparsd · 2019-01-05T08:03:19Z

Closing since I've started working on https://github.com/wpsh/wpsh-local

kasparsd added 6 commits September 22, 2018 10:07

Add Composer meta data

95bd2c2

Basic docs

c08374b

Allow custom Chassis config dir

8e4a83e

Detect custom Vagrantfile root directory

9bf2737

Use absolute path for system scripts

c28fa63

Make those relative to the Chassis root

2c2048a

BronsonQuick changed the title ~~Allow adding Chassis as a Composer dependancy~~ WIP Allow adding Chassis as a Composer dependancy Sep 22, 2018

kasparsd added 11 commits September 23, 2018 09:39

Sync generator should be responsible for creating absolute path

6e09249

Chassis core is now always synced to /chassis

2bf52b1

Current working directory is where the config is

f759a27

Core from /chassis and config from /vagrant

3075ecc

Which can be the same in some instances

Core files from Chassis

046fbe7

Simplify config and Chassis path logic

4b857d4

Core files are in the Chassis directory

3aeb6a6

Introduce support for CHASSIS_CWD

04255fd

Always set the defaults

94827b5

Group all references to Chassis root

5c685f5

Introduce chassis_config_dir which defaults to Chassis root but can be configured to anything

Document CHASSIS_CWD

9141954

kasparsd commented Sep 24, 2018

View reviewed changes

kasparsd added 2 commits September 24, 2018 15:33

Sync extensions directory to /vagrant for back compat

b1a2c70

Reference the correct env variable

dc5fdc6

kasparsd added a commit to wpsh/chassis-composer-demo that referenced this pull request Sep 24, 2018

Demo of the suggested implementation

152fd7b

Chassis/Chassis#583

Everything Chassis is inside the Chassis root

a623461

kasparsd changed the title ~~WIP Allow adding Chassis as a Composer dependancy~~ Allow adding Chassis as a Composer dependancy Sep 24, 2018

kasparsd added 4 commits September 24, 2018 17:17

Ensure that directories exist

9f6403d

Track the sample extension

c52ffd7

Account for @@dir being equal to @@config_dir

0402eab

Use relative path for the Chassis root sync definition

Use absolute path or Vagrant will pick the PWD instead

1a41a04

kasparsd added 2 commits September 24, 2018 18:40

Map the config during Vagrant init

368aa50

A workaround for when chassis_dir is equal to chassis_config_dir

8937110

kasparsd changed the title ~~Allow adding Chassis as a Composer dependancy~~ WIP Allow adding Chassis as a Composer dependancy Sep 24, 2018

Use the absolute path

ce129f9

kasparsd changed the title ~~WIP Allow adding Chassis as a Composer dependancy~~ Allow adding Chassis as a Composer dependancy Oct 6, 2018

BronsonQuick requested a review from rmccue October 6, 2018 07:32

All Chassis core files should be synced to /vagrant

847c14d

kasparsd commented Oct 11, 2018

View reviewed changes

rmccue requested changes Oct 11, 2018

View reviewed changes

kasparsd added 2 commits October 11, 2018 11:13

Don’t track the content directory

df6fd07

Vagrant will fail to mount if the directory is missing

94d5577

kasparsd commented Oct 11, 2018

View reviewed changes

kasparsd closed this Jan 5, 2019

kasparsd deleted the feature/composer-dep-support branch January 5, 2019 08:03

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Allow adding Chassis as a Composer dependancy #583

Allow adding Chassis as a Composer dependancy #583

kasparsd commented Sep 22, 2018 •

edited

BronsonQuick commented Sep 22, 2018

kasparsd Sep 24, 2018

kasparsd Sep 24, 2018

kasparsd Sep 24, 2018

kasparsd commented Sep 24, 2018

kasparsd commented Oct 6, 2018

rmccue commented Oct 8, 2018

kasparsd commented Oct 11, 2018

kasparsd Oct 11, 2018

rmccue Oct 11, 2018

kasparsd Oct 11, 2018

kasparsd Oct 11, 2018

rmccue Oct 11, 2018

kasparsd Oct 11, 2018

rmccue Oct 11, 2018

rmccue Oct 11, 2018

rmccue Oct 11, 2018

kasparsd Oct 11, 2018

rmccue commented Oct 11, 2018

kasparsd Oct 11, 2018

kasparsd commented Oct 11, 2018

kasparsd commented Jan 5, 2019

Allow adding Chassis as a Composer dependancy #583

Allow adding Chassis as a Composer dependancy #583

Conversation

kasparsd commented Sep 22, 2018 • edited

Objectives

Suggested Changes

Tasks

Examples

Example: Plugin Development

Example: WP Core Development

Known Issues

Notes

BronsonQuick commented Sep 22, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kasparsd commented Sep 24, 2018

kasparsd commented Oct 6, 2018

rmccue commented Oct 8, 2018

kasparsd commented Oct 11, 2018

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

rmccue commented Oct 11, 2018

Choose a reason for hiding this comment

kasparsd commented Oct 11, 2018

kasparsd commented Jan 5, 2019

kasparsd commented Sep 22, 2018 •

edited