docman 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0f0ba6187a0fad64e125554d5d75a17c3e6fda06
-  data.tar.gz: 56c484c7c676ccbb7d7ba394f59e1a32e4d48c2f
+  metadata.gz: 4bab1348bae18d45a114e6b4d6b09062941dea2b
+  data.tar.gz: aea9b94d3dcc51c3c8434742656f8d088a31e5fa
 SHA512:
-  metadata.gz: 771396971be50da7bf5df9063620b69a40e2728c4de3ff80f6f323f36318108f687b688c466ced4197a615f8341919a90f8e4736d404b6dcb2a340aa5090e4d6
-  data.tar.gz: 3179ec03c8f81b8aa86cc4ddea9a2bbee82baa09a5b4b99103fb1fbd84b27b56f9a7170d70c61a927ecb482712f07b012d6c4bef83111cb5b8f8b5711a6c4454
+  metadata.gz: f92686f1ef0f5da95066dfbf18ef3b6d784d00df281347126855cbca9ee9a919596ce1d0d6b67634d5f11e91d4ff06b817b7b5d95d82eb9eae96f9d6d467a309
+  data.tar.gz: fe889237d4ca329320f242e9e86655f9e589b7186deb41ac39f2a091defc898298b2c374ea14a91dd7183c549d70db3b16db47d0571082412bda84f88ec22d56

data/README.md

@@ -1,6 +1,8 @@
 # Docman
 
-Docman made for DOCroot MANagement for Drupal projects
+Docman made for DOCroot MANagement for Drupal projects. Useful to manage multiple websites in one Drupal multisite installation. We are assuming that there is a git repository with Drupal core and multiple git repositories for each website in multisite environment (think about each repository containing /modules /themes /libraries, etc). This becomes useful, if you can setup a middleware like jenkins which will effectively "build" your multisite environment using this tool. 
+
+Notes: we are speaking about the code only, media files should be managed separately and for now are out of scope of this tool.
 
 ## Installation
 
@@ -16,13 +18,24 @@ Or install it yourself as:
 
     $ gem install docman
 
-## Usage
+## Usage (in process of documentation)
+
+Build local environment:
+
+    $ docman build local environment
+
+Build the destination docroot using your settings:
+
+    $ docman build <docroot> stable
+
+Deploy built docroot (Drupal core with multiple websites in multisite) to your environment:
 
+    $ docman deploy <docroot>
 
 ## Contributing
 
-1. Fork it ( https://github.com/aroq/docman/fork )
+1. Fork it ( https://github.com/Adyax/docman/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
-5. Create a new Pull Request
+5. Create a new Pull Request

data/bin/functions.sh

@@ -0,0 +1,265 @@
+#!/bin/bash
+
+#
+# Check if git directory has no changes.
+#
+dm_is_clean () {
+    ${git} rev-parse --verify HEAD >/dev/null || echo 1
+    ${git} update-index -q --ignore-submodules --refresh
+    err=0
+
+    if ! ${git} diff-files --quiet --ignore-submodules
+    then
+        err=1
+    fi
+
+    if ! ${git} diff-index --cached --quiet --ignore-submodules HEAD --
+    then
+        err=1
+    fi
+
+    test -z "$(git status --porcelain)" || err=1
+
+    if [ $err = 1 ]
+    then
+        echo $err
+    fi
+}
+
+#
+# Git subtree add/pull depending on dir existance. 
+#
+dm_git_subtree_pull () {
+  if [ ! -d "$1" ]; then
+    dm_debug "Subtree add $1 $2 $3"
+    ${git} subtree add --squash --prefix=$1 $2 $3
+  else
+    dm_debug "Subtree pull $1 $2 $3"
+    ${git} subtree pull --squash --prefix=$1 $2 $3 -m "Subtree pull $1 $2 $3"
+  fi
+}
+
+#
+# Git subtree add/pull depending on dir existance.
+#
+dm_git_get () {
+  _version=${3:-master}
+  _target=${4:-branch}
+  if [ ! -d "$2" ]; then
+    dm_debug "Local repository not exists: $1 $2"
+    ${git} clone $1 $2
+    cd $2
+    ${git} checkout $3
+
+  else
+    cd $2
+    dm_debug "Local repository exists: $1 $2"
+    if [[ "$_target" == 'branch' ]]; then
+      ${git} pull origin $3
+    elif [[ "$_target" == 'tag' ]]; then
+      echo $4
+      ${git} checkout $3
+    fi
+  fi
+}
+
+#
+# Git get version (branch or tag).
+#
+dm_git_checkout_and_copy () {
+  _DIR=${WORKSPACE}/attic/$1
+  mkdir -p $_DIR
+  if [[ ! -d "$_DIR/$3/$4" ]]; then
+    ${git} clone $2 $_DIR/$3/$4
+    cd $_DIR/$3/$4
+    ${git} checkout $4
+  else
+    cd $_DIR/$3/$4
+    if [[ "$3" == 'branch' ]]; then
+      ${git} pull origin $4
+    elif [[ "$3" == 'tag' ]]; then
+      echo $4
+      ${git} checkout $4
+    fi
+  fi
+
+  rm -fR $5
+  mkdir -p $5
+  # We don't need .git here.
+  rm -fR $_DIR/$3/$4/.git
+  cp -fR $_DIR/$3/$4/. $5/
+  rm -fR $_DIR/$3/$4/
+}
+
+dm_find_repo_dir_by_name () {
+  basename="$(basename "${1}")"
+  needle="$(basename "${2}")"
+  if [[ $basename == "$needle" ]]; then
+    echo $1
+    return
+  fi
+
+  for dirname in $1/*; do
+    [ -d "$dirname" ] || continue # if not a directory, skip
+    dm_find_repo_dir_by_name $dirname $2
+  done
+}
+
+dm_get_repo_state_config () {
+  repo_dir=$(dm_find_repo_dir_by_name $1 $2)
+  if [ -d "$repo_dir/_states" ]; then
+    dm_read_properties_file $repo_dir/_states/${3}.properties $4
+  else
+    echo "No state dir"
+    exit 1
+  fi 
+}
+
+dm_write_properties_file_value () {
+  sed -i '' "s/^\($2\s*=\s*\).*\$/\1$3/" $1
+}
+
+dm_set_repo_state_config () {
+  repo_dir=$(dm_find_repo_dir_by_name $1 $2)
+  if [ -d "$repo_dir/_states" ]; then
+    dm_write_properties_file_value $repo_dir/_states/${3}.properties VERSION_TYPE $4
+    dm_write_properties_file_value $repo_dir/_states/${3}.properties VERSION $5
+  else
+    echo "No state dir"
+    exit 1
+  fi 
+
+  cd "$repo_dir"
+  ${git} add -A
+  ${git} commit -m "Updated $2 $3 to $4-$5"
+  ${git} push origin master
+}
+
+dm_build_recursive () {
+  # Skip if no info.properties file.
+  [ -f "${1}/info.properties" ] || return
+
+  dm_read_properties_file ${1}/info.properties
+
+  BUILD_DIR_NAME="$(basename "${2}")"
+  BUILD_DIR="$2"
+  ITEM_TYPE_PARAM="target_${_type}_deploy_as"
+  ITEM_TYPE=${!ITEM_TYPE_PARAM}
+
+  dm_read_properties_file $1/_states/${_DM_BUILD_STATE}.properties
+  echo "Install into $BUILD_DIR, Type: $ITEM_TYPE, Version: $VERSION_TYPE-$VERSION"
+
+  if [[ $ITEM_TYPE == "repo" ]]; then
+    dm_git_get ${repo} $BUILD_DIR $VERSION $VERSION_TYPE
+    ROOT_REPO_DIR="$BUILD_DIR"
+  fi
+
+  if [[ $ITEM_TYPE == "dir" ]]; then
+    mkdir -p $BUILD_DIR
+  fi
+
+  if [[ $ITEM_TYPE == "copy_strip_git" ]]; then
+    cd $ROOT_REPO_DIR
+    #dm_git_subtree_pull $_subtree_prefix $repo $VERSION
+    dm_git_checkout_and_copy $_subtree_prefix $repo $VERSION_TYPE $VERSION $BUILD_DIR
+  fi
+
+  if [[ $ITEM_TYPE == "drupal" ]]; then
+    dm_debug "Install Drupal"
+    # Build docroot dir.
+    if [ -f "$BUILD_DIR/modules/system/system.info" ]; then
+      INSTALLED_DRUPAL_VERSION=$(grep "version = \"" $BUILD_DIR/modules/system/system.info | awk -F\" '{print $2}')
+    fi
+
+    # Install Drupal.
+    mkdir -p $BUILD_DIR
+    if [[ ! "$INSTALLED_DRUPAL_VERSION" == "$VERSION" ]] || [[ "$_FORCE" == "1" ]]
+    then
+      TEMP_DRUPAL_DIR=`mktemp -d -t 'drupal'`
+      mkdir -p $TEMP_DRUPAL_DIR
+      if [ ! -d "$TEMP_DRUPAL_DIR/drupal-${VERSION}" ] || [[ "$_FORCE" == "1" ]]
+      then
+        cd $TEMP_DRUPAL_DIR
+        drush dl drupal-${VERSION} --yes
+        rm -fR drupal-${VERSION}/sites
+      fi
+
+      rm -fR $BUILD_DIR
+      mkdir -p $BUILD_DIR
+      cp -fR $TEMP_DRUPAL_DIR/drupal-${VERSION}/. $BUILD_DIR
+      #rm -fR ${WORKSPACE}/drupal/drupal-${VERSION}
+    else
+      echo "Drupal already installed."
+    fi
+  fi
+
+  cd $BUILD_DIR
+  for dirname in $1/*; do
+    [ -d "$dirname" ] || continue # if not a directory, skip
+    basename="$(basename "${dirname}")"
+    dm_build_recursive $dirname $2/$basename
+  done
+}
+
+#
+# Git commit if there are changes in dir.
+#
+dm_git_commit_if_changes () {
+  repo_clean=$(dm_is_clean)
+  if [ "$repo_clean" == "1" ]
+  then
+    #${git} merge --ff-only
+    ${git} add --all $1
+    ${git} commit -m "$2"
+    changed=1
+  fi
+}
+
+#
+# Git subtree add/pull depending on dir existance.
+#
+dm_debug () {
+  if [ "$_DEBUG" == "1" ]; then
+    echo 1>&2 "$@"
+  fi
+}
+
+dm_read_properties_file () {
+  dm_debug "Read properties: $1 $2"
+  TEMPFILE=`mktemp 2>/dev/null || mktemp -t 'tmp'`
+  cat $1 |
+  if [ "$(uname)" == "Darwin" ]
+  then
+    sed -Ee 's/"/"/'g|sed -Ee "s/(.*)=(.*)/$2\1=\"\2\"/g">$TEMPFILE
+  else  
+    sed -re 's/"/"/'g|sed -re "s/(.*)=(.*)/$2\1=\"\2\"/g">$TEMPFILE
+  fi
+  source $TEMPFILE
+  rm $TEMPFILE
+}
+
+#
+# Send message to slack.
+#
+dm_slack_send () {
+  slack_message_fallback="$1"
+  slack_message_text="$1"
+  slack_message_pretext=""
+
+  if [ "$enable_slack_notification" == "1" ]
+  then
+    if [ -n "$2" ]
+    then
+    slack_message_color="$2"
+    attachments="\"attachments\": [{\"fallback\": \"${slack_message_fallback}\", \"text\": \"${slack_message_text}\", \"pretext\": \"${slack_message_pretext}\", \"color\": \"${slack_message_color}\", \"fields\": [ 
+        { \"title\": \"Project\", \"value\": \"${project}\", \"short\": true },
+        { \"title\": \"Environment\", \"value\": \"prod\", \"short\": true }
+      ]}],"
+    else 
+      attachments=""  
+    fi  
+
+    curl -X POST --data-urlencode "payload={\"channel\": \"#${slack_channel}\", $attachments \"username\": \"${slack_username}\", \"text\": \"$1\", \"icon_emoji\": \":ghost:\"}" ${slack_address}?token=${slack_token}
+  fi  
+}
+

data/config/config.yaml

@@ -4,52 +4,49 @@ deploy_targets:
     handler: :common_deployer
     builders:
       root:
-        handler: :common
-        type: dir
+        handler: :dir_builder
       drupal:
-        handler: :drupal
-        type: drupal
+        handler: :drupal_drush_builder
       repo:
-        handler: :git
-        type: direct
+        handler: :git_direct_builder
       dir:
-        handler: :common
-        type: dir
+        handler: :dir_builder
+    environments:
+      development: local
+      staging: local
+      stable: local
   acquia:
     handler: :git_deployer
-    deploy_action: git_push
     builders:
       root:
-        handler: :git
-        type: direct
-        after_build_actions:
-          - git_commit
+        handler: :git_direct_builder
+        hooks:
+          builder:
+            after_execute:
+              - type: :git_commit
+                execution_dir: $PROJECT$
       drupal:
-        handler: :drupal
-        type: drupal
-        after_build_actions:
-          - git_commit
+        handler: :drupal_drush_builder
+        hooks:
+          builder:
+            after_execute:
+              - type: :git_commit
+                execution_dir: $PROJECT$
       repo:
-        handler: :git
-        type: strip
-        after_build_actions:
-          - git_commit
+        handler: :git_strip_builder
+        hooks:
+          builder:
+            after_execute:
+              - type: :git_commit
+                execution_dir: $PROJECT$
       dir:
-        handler: :common
-        type: dir
-        after_build_actions:
-          - git_commit
-
-environments:
-  local:
-    deploy_target: local
-    state: development
-  dev:
-    deploy_target: acquia
-    state: development
-  test:
-    deploy_target: acquia
-    state: staging
-  prod:
-    deploy_target: acquia
-    state: stable
+        handler: :dir_builder
+        hooks:
+          builder:
+            after_execute:
+              - type: :git_commit
+                execution_dir: $PROJECT$
+    environments:
+      development: dev
+      staging: test
+      stable: test

data/config/cucumber.yml

@@ -0,0 +1,2 @@
+---
+default: -r features

data/docman.gemspec

@@ -23,4 +23,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "aruba"
 
   spec.add_dependency 'thor'
+  spec.add_dependency 'hash-deep-merge'
+  spec.add_dependency 'net-sftp'
+  spec.add_dependency 'hooks'
 end

data/features/acquia/acquia.feature

@@ -0,0 +1,65 @@
+Feature: Docroot management - Acquia
+
+  In order to manage docroot
+  As a developer using Cucumber
+  I want to use the deploy steps to deploy to local
+
+  @announce
+  @no-clobber
+  @build
+  @acquia
+  Scenario: Acquia build development
+    Given I cd to "sample-docroot"
+    Then I run `docman build acquia development`
+    Then the exit status should be 0
+    Then the following directories should exist:
+      | master |
+      | master/docroot |
+      | master/docroot/sites |
+      | master/hooks |
+      | master/profiles |
+      | master/profiles/sample_profile |
+      | master/projects/sample_project1 |
+      | master/projects/sample_project2 |
+      | master/docroot/profiles/sample_profile |
+    Then the following files should exist:
+      | master/docroot/CHANGELOG.txt |
+
+  @announce
+  @no-clobber
+  @acquia
+  @develop
+  @deploy
+  Scenario: Acquia deploy sample project 1 develop
+    Given I cd to "sample-docroot"
+    Then I run `docman deploy acquia sample_project1 branch develop`
+    Then the exit status should be 0
+    Then the following directories should exist:
+      | master |
+      | master/docroot |
+      | master/docroot/sites |
+      | master/hooks |
+      | master/profiles |
+      | master/profiles/sample_profile |
+      | master/projects/sample_project1 |
+      | master/projects/sample_project2 |
+
+  @announce
+  @no-clobber
+  @acquia
+  @deploy
+  @master
+  @sample_project2
+  Scenario: Acquia deploy sample project 2 master
+    Given I cd to "sample-docroot"
+    Then I run `docman deploy acquia sample_project2 branch master`
+    Then the exit status should be 0
+    Then the following directories should exist:
+      | master |
+      | master/docroot |
+      | master/docroot/sites |
+      | master/hooks |
+      | master/profiles |
+      | master/profiles/sample_profile |
+      | master/projects/sample_project1 |
+      | master/projects/sample_project2 |