[Blueprints v2] Blueprint validation

[JanJakes]

WIP alternative exploration to #142.

Closes #132.

[JanJakes]

Here's a bit of a demo of what this WIP does now:

$ blueprint.php info blueprint.json

ERRORS FOUND:

  themes:
    Invalid path "wp-content/invalid/test.php". Expected to match "wp-content/themes/*".
  plugins:
    Invalid path "wp-content/invalid/test.php". Expected to match "wp-content/plugins/*".
  media:
    Invalid path "wp-content/invalid/image.jpg". Expected to match "wp-content/uploads/*".
  content:
    Invalid path "wp-content/content/invalid/test.xml". Expected to match "wp-content/content/posts/*".
    Invalid path "wp-content/content/invalid/test.xml". Expected to match "wp-content/content/posts/*".

BLUEPRINT:

  version: 2
  siteLanguage: "en_US"
  wordpressVersion: "6.7"
  constants: {"TEST_CONSTANT":"plugins"}
  siteOptions: {"blogname":"Full Featured Test Site"}
  plugins: ["./wp-content/plugins/test.php","./wp-content/invalid/test.php"]
  themes: ["./wp-content/themes/test.php","./wp-content/invalid/test.php"]
  media: ["./wp-content/uploads/image.jpg","./wp-content/invalid/image.jpg"]
  content: [{"type":"posts","source":"./wp-content/content/posts/test.xml"},{"type":"posts","source":"./wp-content/content/invalid/test.xml"},{"type":"posts","source":["./wp-content/content/posts/test.xml","./wp-content/content/invalid/test.xml"]}]
  additionalStepsAfterExecution: []

EXECUTION PLAN:

  [1] defineConstants
        constants: {"TEST_CONSTANT":"plugins"}

  [2] setSiteOptions
        options: {"blogname":"Full Featured Test Site"}

  [3] installTheme
        source: "./wp-content/themes/test.php"
        active: false
        importStarterContent: false

  [4] installTheme
        source: "./wp-content/invalid/test.php"
        active: false
        importStarterContent: false

  [5] installPlugin
        source: "./wp-content/plugins/test.php"

  [6] installPlugin
        source: "./wp-content/invalid/test.php"

  [7] importMedia
        media: ["./wp-content/uploads/image.jpg","./wp-content/invalid/image.jpg"]

  [8] setSiteLanguage
        language: "en_US"

  [9] importContent
        content: [{"type":"posts","source":"./wp-content/content/posts/test.xml"},{"type":"posts","source":"./wp-content/content/invalid/test.xml"},{"type":"posts","source":["./wp-content/content/posts/test.xml","./wp-content/content/invalid/test.xml"]}]

[JanJakes]

@adamziel The validation is not complete yet — some steps have more complex requirements — but I think this architecture could work.

At the moment, the BlueprintParser::parse() method returns a Blueprint instance that exposes the plan via $bluprint->getExecutionPlan(). However, that's just an intermediate array of step names and args that are later converted to the step instances.

I think I could take this further and make the parser (maybe renaming it to BlueprintCompiler) create the plan as step instances directly. This would also enable us to move the validation into the step classes by adding a validate( $args ) method to StepInterface. Not sure whether to do this move or not; it has pros and cons, but it's something we could consider.

[adamziel]

I think I could take this further and make the parser (maybe renaming it to BlueprintCompiler) create the plan as step instances directly.

This could be potentially useful in the future but it wouldn't make that much of a difference now. Let's keep this in mind and revisit it when a good use-case comes up.

[adamziel]

We'd need to run this against a list of data references and confirm that URLReference, GitPath etc. fail to resolve while the AbsoluteLocalPath resolves successfully, similarly to what DataReference::create() does. We have a bunch of data reference syntaxes with possibly more to come, and not even all of them are strings.

[adamziel]

The message slightly confused me at first, as in I went "oh, it's about the ./ prefix. No, wait, it's about the /plugins/ part". I wonder if we could rephrase it somehow to make it clear it's about the parent path, not syntax micronuances.

[adamziel]

This looks good @JanJakes! I've left a few notes and there's a few failing tests. We're pretty close to merging