Skip to content

TEY-101: Write integration test for deploy hook execution#199

Merged
jfuechsl merged 20 commits intodevelopfrom
feature/tey-101-write-integration-test-for-deploy-hook-execution
Feb 13, 2020
Merged

TEY-101: Write integration test for deploy hook execution#199
jfuechsl merged 20 commits intodevelopfrom
feature/tey-101-write-integration-test-for-deploy-hook-execution

Conversation

@ess
Copy link
Contributor

@ess ess commented Feb 12, 2020 •
edited
Loading 

Feature: Running A Deploy Hook
  In order to inject needed extra steps into the deploy process, I want to be able
  to provide hooks for various pre-defined callbacks. Meanwhile, serverside needs
  to know how to execute such hooks.

  Background:
    Given my account name is TestAccount
    And my app's name is george
    And my app lives in an environment named george_fliggerbop
    And the framework env for my environment is staging

  Scenario Outline: Running a callback
    When I run `engineyard-serverside hook <Callback Name> --app=george --environment-name=george_fliggerbop --account-name=TestAccount --framework-env=staging`
    Then I see output indicating that the <Callback Name> hooks were processed

    Examples:
      | Callback Name         |
      | before_deploy         |
      | before_bundle         |
      | after_bundle          |
      | before_compile_assets |
      | after_compile_assets  |
      | before_migrate        |
      | after_migrate         |
      | before_symlink        |
      | after_symlink         |
      | before_restart        |
      | after_restart         |
      | after_deploy          |

  Scenario Outline: Running a callback with no hooks present
    Given my app has no deploy hooks
    And my app has no service hooks
    When I run the <Callback Name> callback
    Then I see a notice that the <Callback Name> callback was skipped

    Examples:
      | Callback Name         |
      | before_deploy         |
      | before_bundle         |
      | after_bundle          |
      | before_compile_assets |
      | after_compile_assets  |
      | before_migrate        |
      | after_migrate         |
      | before_symlink        |
      | after_symlink         |
      | before_restart        |
      | after_restart         |
      | after_deploy          |

  Scenario Outline: Running a callback with a Ruby deploy hook
    Given my app has a <Callback Name> ruby deploy hook
    When I run the <Callback Name> callback
    Then the <Callback Name> ruby deploy hook is executed

    Examples:
      | Callback Name         |
      | before_deploy         |
      | before_bundle         |
      | after_bundle          |
      | before_compile_assets |
      | after_compile_assets  |
      | before_migrate        |
      | after_migrate         |
      | before_symlink        |
      | after_symlink         |
      | before_restart        |
      | after_restart         |
      | after_deploy          |

  Scenario Outline: Running a callback with an Executable deploy hook
    Given my app has a <Callback Name> executable deploy hook
    When I run the <Callback Name> callback
    Then the <Callback Name> executable deploy hook is executed

    Examples:
      | Callback Name         |
      | before_deploy         |
      | before_bundle         |
      | after_bundle          |
      | before_compile_assets |
      | after_compile_assets  |
      | before_migrate        |
      | after_migrate         |
      | before_symlink        |
      | after_symlink         |
      | before_restart        |
      | after_restart         |
      | after_deploy          |

  Scenario Outline: Running a callback with both Ruby and Executable deploy hooks
    Given my app has a <Callback Name> executable deploy hook
    Given my app has a <Callback Name> ruby deploy hook
    When I run the <Callback Name> callback
    Then the <Callback Name> ruby deploy hook is executed
    But the <Callback Name> executable deploy hook is not executed

    Examples:
      | Callback Name         |
      | before_deploy         |
      | before_bundle         |
      | after_bundle          |
      | before_compile_assets |
      | after_compile_assets  |
      | before_migrate        |
      | after_migrate         |
      | before_symlink        |
      | after_symlink         |
      | before_restart        |
      | after_restart         |
      | after_deploy          |

  Scenario Outline: Running a callback with a Ruby service hook
    Given I have a service named selective
    And my service has a <Callback Name> ruby hook
    When I run the <Callback Name> callback
    Then the <Callback Name> ruby hook for my service is executed

    Examples:
      | Callback Name         |
      | before_deploy         |
      | before_bundle         |
      | after_bundle          |
      | before_compile_assets |
      | after_compile_assets  |
      | before_migrate        |
      | after_migrate         |
      | before_symlink        |
      | after_symlink         |
      | before_restart        |
      | after_restart         |
      | after_deploy          |

  Scenario Outline: Running a callback with an executable service hook
    Given I have a service named selective
    And my service has a <Callback Name> executable hook
    When I run the <Callback Name> callback
    Then the <Callback Name> executable hook for my service is executed

    Examples:
      | Callback Name         |
      | before_deploy         |
      | before_bundle         |
      | after_bundle          |
      | before_compile_assets |
      | after_compile_assets  |
      | before_migrate        |
      | after_migrate         |
      | before_symlink        |
      | after_symlink         |
      | before_restart        |
      | after_restart         |
      | after_deploy          |

  Scenario Outline: Running a callback with both Ruby and Executable service hooks
    Given I have a service named selective
    Given my service has a <Callback Name> executable hook
    Given my service has a <Callback Name> ruby hook
    When I run the <Callback Name> callback
    Then the <Callback Name> ruby hook for my service is executed
    But the <Callback Name> executable hook for my service is not executed

    Examples:
      | Callback Name         |
      | before_deploy         |
      | before_bundle         |
      | after_bundle          |
      | before_compile_assets |
      | after_compile_assets  |
      | before_migrate        |
      | after_migrate         |
      | before_symlink        |
      | after_symlink         |
      | before_restart        |
      | after_restart         |
      | after_deploy          |

  Scenario Outline: Running a callback with botth service hooks and deploy hooks
    Given my app has a <Callback Name> executable deploy hook
    And I have a service named selective
    Given my service has a <Callback Name> ruby hook
    When I run the <Callback Name> callback
    Then the <Callback Name> ruby hook for my service is executed
    And the <Callback Name> executable deploy hook is executed

    Examples:
      | Callback Name         |
      | before_deploy         |
      | before_bundle         |
      | after_bundle          |
      | before_compile_assets |
      | after_compile_assets  |
      | before_migrate        |
      | after_migrate         |
      | before_symlink        |
      | after_symlink         |
      | before_restart        |
      | after_restart         |
      | after_deploy          |


  Scenario Outline: Executable hooks without the executable bit get skipped
    Given my app has a <Callback Name> executable deploy hook
    But my app's <Callback Name> executable deploy hook is not actually executable
    And I have a service named selective
    Given my service has a <Callback Name> executable hook
    When I run the <Callback Name> callback
    Then the <Callback Name> executable hook for my service is executed
    But the <Callback Name> executable deploy hook is not executed

    Examples:
      | Callback Name         |
      | before_deploy         |
      | before_bundle         |
      | after_bundle          |
      | before_compile_assets |
      | after_compile_assets  |
      | before_migrate        |
      | after_migrate         |
      | before_symlink        |
      | after_symlink         |
      | before_restart        |
      | after_restart         |
      | after_deploy          |

    @error
  Scenario Outline: Ruby hooks with syntax errors cause an error
    Given my app has a <Callback Name> ruby deploy hook
    And I have a service named selective
    And my service has a <Callback Name> ruby hook
    But my service's <Callback Name> ruby hook contains syntax errors
    When I run the <Callback Name> callback
    Then I see a notice about the <Callback Name> syntax error
    But my service's <Callback Name> ruby hook is not executed
    And the <Callback Name> ruby deploy hook is not executed

    Examples:
      | Callback Name         |
      | before_deploy         |
      | before_bundle         |
      | after_bundle          |
      | before_compile_assets |
      | after_compile_assets  |
      | before_migrate        |
      | after_migrate         |
      | before_symlink        |
      | after_symlink         |
      | before_restart        |
      | after_restart         |
      | after_deploy          |

    @failure
  Scenario Outline: Ruby hooks with syntax errors cause an error
    Given my app has a <Callback Name> ruby deploy hook
    And I have a service named selective
    And my service has a <Callback Name> ruby hook
    But my service's <Callback Name> ruby hook is prone to errors
    When I run the <Callback Name> callback
    Then the <Callback Name> ruby hook for my service is executed
    But I see a notice about the <Callback Name> exception
    And the <Callback Name> ruby deploy hook is not executed

    Examples:
      | Callback Name         |
      | before_deploy         |
      | before_bundle         |
      | after_bundle          |
      | before_compile_assets |
      | after_compile_assets  |
      | before_migrate        |
      | after_migrate         |
      | before_symlink        |
      | after_symlink         |
      | before_restart        |
      | after_restart         |
      | after_deploy          |

ess added 5 commits February 12, 2020 05:18
@ess
Testing the hook execution workflow
8733117 
The following scenarios are covered:

* There are no hooks
* There is a ruby deploy hook
* There is an executable deploy hook
@ess
For my next trick ...
9956b0b 
... we add some good ol `puts` tests to try to figure out why the
tests are failing on 1.8.7
@ess
1.8.7 hash ordering nonsense strikes again
324c85c
@ess
still trying
da95cbd
@ess
Relaxed executable hook execution detection
a0da7b4 
Instead of matchingg the entire command, including environment,
that is needed to execute an executable hook, now we just check
to make sure that the proper executable wrapper is run with the
correct callback name.
@ess ess added the wip label Feb 12, 2020
@ess ess self-assigned this Feb 12, 2020
ess added 15 commits February 12, 2020 06:37
@ess
Added scenario around the preference for ruby hooks
9a2ec02
@ess
Tests running ruby service hooks
7e1b73c
@ess
Tests running executable service hooks
20ba767
@ess
Ruby service hooks are favored over executables
61c1c2d
@ess
Service hooks and deploy hooks can run at the same time
c39f071
@ess
Executable hooks must actually be executable
5a2e3e2
@ess
Ensured shell status code for all scenarios
cdfe951
@ess
Tests ruby hook syntax error behavior
3a1f18b
@ess
Well, that's an interesting twist
7c8db73 
The "ruby deploy hook with syntax errors" scenario works in 1.8.7,
but not in any Travis environment with a more recent ruby.

So yeah. figuring out what's up with that.
@ess
Still debugging
cfb156a
@ess
Still debugging
b1d86b3
@ess
Still debugging
4868904
@ess
Removed debugging code
c4d7f29 
It turns out that a string isn't a string unless you dern well
convert it to a string.
@ess
Tests ruby hook raises exception scenario
13976c9
@ess
cleaned up feature file
799fcfb
@ess ess removed the wip label Feb 13, 2020
@ess ess requested a review from jfuechsl February 13, 2020 12:22
@jfuechsl jfuechsl added the LGTM label Feb 13, 2020
@jfuechsl jfuechsl merged commit 494796a into develop Feb 13, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

1 more reviewer

@jfuechsl jfuechsl jfuechsl approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

@ess ess

Labels

LGTM

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@ess @jfuechsl