dkdeploy-typo3-cms 7.0.0

data/features/advanced_typo3.feature

@@ -0,0 +1,156 @@
+Feature: Test tasks for namespace 'typo3:cms'
+
+	Background:
+		Given a test app with the default configuration
+		And the remote server is cleared
+		And I run `cap dev deploy`
+
+	Scenario: Generate custom ERB Template with custom name
+		Given I successfully run `cap dev typo3:cms:generate_additional_configuration_template['vendor/customer_specific_config.php.erb']`
+		Then a file named "vendor/customer_specific_config.php.erb" should exist
+
+	Scenario: Use custom ERB Template to generate "AdditionalConfiguration.php" file
+		Given a file named "vendor/customer_specific_config.php.erb" with:
+		"""
+<?php
+<% if File.exist?(File.join('htdocs', 'typo3conf', 'AdditionalConfiguration.php')) %>
+<%= sanitize_php File.read(File.join('htdocs', 'typo3conf', 'AdditionalConfiguration.php')) %>
+<% end %>
+$GLOBALS['TYPO3_CONF_VARS']['SYS']['displayErrors'] = 1;
+		"""
+		When I successfully run `cap dev typo3:cms:setup_additional_configuration['vendor/customer_specific_config.php.erb']`
+		And the remote file "current_path/typo3conf/AdditionalConfiguration.php" should contain exactly:
+		"""
+<?php
+putenv('TYPO3_DISABLE_CORE_UPDATER=1');
+$GLOBALS['TYPO3_CONF_VARS']['SYS']['displayErrors'] = 1;
+		"""
+
+
+	Scenario: Setup no stage specific configuration
+		Given a file named "htdocs/typo3conf/AdditionalConfiguration.php" with:
+		"""
+		<?php
+		// I am the default AdditionalConfiguration.php.
+		?>
+		"""
+		When I successfully run `cap dev typo3:cms:setup_additional_configuration --trace`
+		Then a remote file named "current_path/typo3conf/AdditionalConfiguration.php" should exist
+		And the remote file "current_path/typo3conf/AdditionalConfiguration.php" should contain exactly:
+		"""
+<?php
+// Content of default configuration file
+// I am the default AdditionalConfiguration.php.
+
+// Include section
+		"""
+
+	Scenario: Setup stage specific configuration
+		Given a file named "htdocs/typo3conf/AdditionalConfiguration.php" with:
+		"""
+		<?php
+		// I am the default AdditionalConfiguration.php and I shall be merged!
+		?>
+		"""
+		And a file named "config/typo3/AdditionalConfiguration.dev.php" with:
+		"""
+
+		<?php
+		// I am AdditionalConfiguration.dev.php. I hope to survive this merge.
+		// Here are some additional settings
+		?>
+		"""
+		When I successfully run `cap dev typo3:cms:setup_additional_configuration`
+		Then a remote file named "current_path/typo3conf/AdditionalConfiguration.php" should exist
+		And the remote file "current_path/typo3conf/AdditionalConfiguration.php" should contain exactly:
+		"""
+<?php
+// Content of default configuration file
+// I am the default AdditionalConfiguration.php and I shall be merged!
+
+// Content of stage configuration file
+// I am AdditionalConfiguration.dev.php. I hope to survive this merge.
+// Here are some additional settings
+
+// Include section
+		"""
+
+	Scenario: Extend file "AdditionalConfiguration" with content from extra configuration files
+		Given a file named "config/typo3/ExtraConfiguration.php" with:
+		"""
+<?php
+$GLOBALS['TYPO3_CONF_VARS']['SYS']['displayErrors'] = 1;
+		"""
+		And I extend the development capistrano configuration variable additional_configuration_files with value ['config/typo3/ExtraConfiguration.php']
+		When I successfully run `cap dev typo3:cms:setup_additional_configuration`
+		Then a remote file named "current_path/typo3conf/AdditionalConfiguration.php" should exist
+		And the remote file "current_path/typo3conf/AdditionalConfiguration.php" should contain exactly:
+		"""
+<?php
+// Content of default configuration file
+putenv('TYPO3_DISABLE_CORE_UPDATER=1');
+
+// Content of additional configuration file "ExtraConfiguration.php"
+$GLOBALS['TYPO3_CONF_VARS']['SYS']['displayErrors'] = 1;
+
+// Include section
+		"""
+
+	Scenario: Extend file "AdditionalConfiguration" with content from extra ruby template configuration files
+		Given a file named "config/typo3/ExtraConfiguration.php.erb" with:
+		"""
+<?php
+$extraConfiguration = '<%= server %>';
+		"""
+		And I extend the development capistrano configuration variable additional_configuration_files with value ['config/typo3/ExtraConfiguration.php.erb']
+		When I successfully run `cap dev typo3:cms:setup_additional_configuration`
+		Then a remote file named "current_path/typo3conf/AdditionalConfiguration.php" should exist
+		And the remote file "current_path/typo3conf/AdditionalConfiguration.php" should contain exactly:
+		"""
+<?php
+// Content of default configuration file
+putenv('TYPO3_DISABLE_CORE_UPDATER=1');
+
+// Content of additional configuration file "ExtraConfiguration.php.erb"
+$extraConfiguration = 'dkdeploy-typo3-cms.dev';
+
+// Include section
+		"""
+
+	Scenario: Extend file "AdditionalConfiguration" with content from server configuration files
+		Given a file named "config/typo3/ServerConfiguration.php" with:
+		"""
+<?php
+$GLOBALS['TYPO3_CONF_VARS']['SYS']['displayErrors'] = 1;
+		"""
+		And I extend the development capistrano configuration from the fixture file additional_configuration_for_server.rb
+		When I successfully run `cap dev typo3:cms:setup_additional_configuration`
+		Then a remote file named "current_path/typo3conf/AdditionalConfiguration.php" should exist
+		And the remote file "current_path/typo3conf/AdditionalConfiguration.php" should contain exactly:
+		"""
+<?php
+// Content of default configuration file
+putenv('TYPO3_DISABLE_CORE_UPDATER=1');
+
+// Content of server "dkdeploy-typo3-cms.dev" configuration file "ServerConfiguration.php"
+$GLOBALS['TYPO3_CONF_VARS']['SYS']['displayErrors'] = 1;
+
+// Include section
+		"""
+
+	Scenario: Task "typo3:cms:remove_extensions" does not remove extension directory
+		Given a successfully deployed TYPO3 application
+		When I successfully run `cap dev typo3:cms:remove_extensions`
+		Then a remote directory named "current_path/typo3conf/ext/realurl" should exist
+
+	Scenario: Task "typo3:cms:remove_extensions" does remove extension directory
+		Given a successfully deployed TYPO3 application
+		And a remote directory named "current_path/typo3conf/ext/test_extension"
+		When I successfully run `cap dev typo3:cms:remove_extensions`
+		Then a remote directory named "current_path/typo3conf/ext/test_extension" should not exist
+
+	Scenario: Task "typo3:cms:create_extension_folders" create needed directories
+		Given a successfully deployed TYPO3 application
+		And a remote directory named "current_path/uploads/tx_realurl" should not exist
+		When I successfully run `cap dev typo3:cms:fix_folder_structure`
+		Then a remote directory named "current_path/uploads/tx_realurl" should exist

data/features/caretaker_key_management.feature

@@ -0,0 +1,36 @@
+Feature: Test tasks in namespace 'caretaker'
+
+  Background:
+    Given a test app with the default configuration
+    And the remote server is cleared
+
+  Scenario: Testing creation of keys
+    When I successfully run `cap dev caretaker:create_keys`
+    Then a remote file named "shared_path/config/privkey.pem" should exist
+    And a remote file named "shared_path/config/pubkey.pem" should exist
+    And a remote file named "caretaker_instance_keys.php" should not exist
+
+  Scenario: Testing forceful creation of keys
+    When I successfully run `cap dev "caretaker:create_keys[yes]"`
+    Then a remote file named "shared_path/config/privkey.pem" should exist
+    And a remote file named "shared_path/config/pubkey.pem" should exist
+    And a remote file named "caretaker_instance_keys.php" should not exist
+
+  Scenario: Testing display of keys
+    Given I successfully run `cap dev "caretaker:create_keys"`
+    When I successfully run `cap dev "caretaker:show_public_key"`
+    And the output should contain "Output file /var/www/dkdeploy/shared/config/pubkey.pem (dkdeploy-typo3-cms.dev):"
+    Then the output should match:
+    """
+    -----BEGIN PUBLIC KEY-----
+    .*
+    -----END PUBLIC KEY-----
+    """
+    And the output should contain:
+    """
+    One line public key (dkdeploy-typo3-cms.dev):
+    """
+    And the output should match:
+    """
+    -----BEGIN PUBLIC KEY-----.*-----END PUBLIC KEY-----
+    """

data/features/clear_cache_on_rollback.feature

@@ -0,0 +1,17 @@
+Feature: Clearing file cache when deployment fails
+  Background:
+    Given a test app with the default configuration
+    And the remote server is cleared
+    And I run `cap dev deploy`
+
+
+  Scenario: When deployment fails after symlinking the new release
+    Given a remote directory named "current_path/typo3temp/Cache"
+    And a remote file named "current_path/typo3temp/Cache/test_cache_file" with:
+    """
+    cached content
+    """
+    And I provoke an exception for testing purposes after symlinking the new release
+    When I run `cap dev deploy`
+    And the exit status should not be 0
+    And a remote file named "current_path/typo3temp/Cache/test_cache_file" should not exist

data/features/cli.feature

@@ -0,0 +1,61 @@
+Feature: Test tasks for namespace 'typo3:cms:cli:run'
+
+  Background:
+    Given a test app with the default configuration
+    And the remote server is cleared
+    And the project is deployed
+
+  Scenario: Running one time
+    And I extend the development capistrano configuration from the fixture file cli_test_tasks.rb
+    When I successfully run `cap dev typo3:cms:cli:break_after_one_run`
+    Then the output should contain "Running cli task for the 1. time"
+    And the output should not contain "Running cli task for the 2. time"
+    And the output should contain "Breaking loop after 1 run because block yields false"
+
+  Scenario: Running several times
+    And I extend the development capistrano configuration from the fixture file cli_test_tasks.rb
+    When I successfully run `cap dev typo3:cms:cli:break_after_three_runs`
+    Then the output should contain "Running cli task for the 1. time"
+    And the output should contain "Running cli task for the 2. time"
+    And the output should contain "Running cli task for the 3. time"
+    And the output should contain "Maximum number of cli calls reached!"
+    And the output should not contain "Breaking loop after 1 run because block yields false"
+    And the output should not contain "Breaking loop after 2 run because block yields false"
+    And the output should not contain "Breaking loop after 3 run because block yields false"
+
+  Scenario: Running one time in release path
+    And I extend the development capistrano configuration from the fixture file cli_break_after_one_run_in_release_path.rb
+    When I successfully run `cap dev deploy`
+    Then the output should contain "Running cli task for the 1. time"
+    And the output should not contain "Running cli task for the 2. time"
+    And the output should contain "Breaking loop after 1 run because block yields false"
+
+  Scenario: Running several times in release path
+    And I extend the development capistrano configuration from the fixture file cli_break_after_three_runs_in_release_path.rb
+    When I successfully run `cap dev deploy`
+    Then the output should contain "Running cli task for the 1. time"
+    And the output should contain "Running cli task for the 2. time"
+    And the output should contain "Running cli task for the 3. time"
+    And the output should contain "Maximum number of cli calls reached!"
+    And the output should not contain "Breaking loop after 1 run because block yields false"
+    And the output should not contain "Breaking loop after 2 run because block yields false"
+    And the output should not contain "Breaking loop after 3 run because block yields false"
+
+  Scenario: Checking injected environment variables
+    When I successfully run `cap dev typo3:cms:cli:run`
+    Then the output should contain "TYPO3_COMPOSER_AUTOLOAD=1"
+
+  Scenario: Checking injected environment variables in release path
+    And I extend the development capistrano configuration from the fixture file cli_test_tasks_with_path.rb
+    When I successfully run `cap dev deploy`
+# Here in the regex string "any character" is used to match the slashes. Every attempt to use the directory slashes failed for unknown reasons
+    Then the output should match /.var.www.dkdeploy.releases.\d{4}-\d{2}-\d{2}-\d{2}-\d{2}-\d{2}.typo3.cli_dispatch\.phpsh/
+    And the output should contain "TYPO3_COMPOSER_AUTOLOAD=1"
+
+  Scenario: Checking injected environment variables
+    When I successfully run `cap dev typo3:cms:cli:upload_wrapper`
+    Then the remote file "current_path/typo3_cms_cli_dispatch.sh" should contain exactly:
+      """
+      #!/usr/bin/env bash
+      TYPO3_COMPOSER_AUTOLOAD='1' TERM='screen-256color' /usr/bin/env php /var/www/dkdeploy/current/typo3/cli_dispatch.phpsh $@
+      """

data/features/step_definitions/mysql.rb

@@ -0,0 +1,75 @@
+Given(/^the TYPO3 table be_users exists$/) do # rubocop:disable Metrics/BlockLength
+  mysql_client = instantiate_mysql_client @database_name
+  mysql_client.query 'DROP TABLE IF EXISTS be_users;'
+  mysql_client.query "CREATE TABLE be_users (
+                                    uid int(11) unsigned NOT NULL auto_increment,
+                                    pid int(11) unsigned DEFAULT '0' NOT NULL,
+                                    tstamp int(11) unsigned DEFAULT '0' NOT NULL,
+                                    username varchar(50) DEFAULT '' NOT NULL,
+                                    password varchar(100) DEFAULT '' NOT NULL,
+                                    admin tinyint(4) unsigned DEFAULT '0' NOT NULL,
+                                    usergroup varchar(255) DEFAULT '' NOT NULL,
+                                    disable tinyint(1) unsigned DEFAULT '0' NOT NULL,
+                                    starttime int(11) unsigned DEFAULT '0' NOT NULL,
+                                    endtime int(11) unsigned DEFAULT '0' NOT NULL,
+                                    lang char(2) DEFAULT '' NOT NULL,
+                                    email varchar(80) DEFAULT '' NOT NULL,
+                                    db_mountpoints text,
+                                    options tinyint(4) unsigned DEFAULT '0' NOT NULL,
+                                    crdate int(11) unsigned DEFAULT '0' NOT NULL,
+                                    cruser_id int(11) unsigned DEFAULT '0' NOT NULL,
+                                    realName varchar(80) DEFAULT '' NOT NULL,
+                                    userMods text,
+                                    allowed_languages varchar(255) DEFAULT '' NOT NULL,
+                                    uc mediumtext,
+                                    file_mountpoints text,
+                                    file_permissions text,
+                                    workspace_perms tinyint(3) DEFAULT '1' NOT NULL,
+                                    lockToDomain varchar(50) DEFAULT '' NOT NULL,
+                                    disableIPlock tinyint(1) unsigned DEFAULT '0' NOT NULL,
+                                    deleted tinyint(1) unsigned DEFAULT '0' NOT NULL,
+                                    TSconfig text,
+                                    lastlogin int(10) unsigned DEFAULT '0' NOT NULL,
+                                    createdByAction int(11) DEFAULT '0' NOT NULL,
+                                    usergroup_cached_list text,
+                                    workspace_id int(11) DEFAULT '0' NOT NULL,
+                                    workspace_preview tinyint(3) DEFAULT '1' NOT NULL,
+                                    category_perms varchar(255) DEFAULT '' NOT NULL,
+                                    PRIMARY KEY (uid),
+                                    KEY parent (pid),
+                                    KEY username (username)
+                      );"
+end
+
+# From TYPO3 CMS V6 Gem:
+Given(/a TYPO3 backend user "(.*)" exists$/) do |username|
+  mysql_client = instantiate_mysql_client @database_name
+  mysql_client.query "INSERT INTO `be_users` (username, admin, crdate, tstamp)
+          VALUES
+            ('#{mysql_client.escape(username)}', 0, UNIX_TIMESTAMP(), UNIX_TIMESTAMP());"
+end
+
+Given(/^the database table `(.*)` exists$/) do |table|
+  mysql_client = instantiate_mysql_client @database_name
+  mysql_client.query "DROP Table IF EXISTS #{mysql_client.escape(table)};"
+  mysql_client.query "CREATE TABLE #{mysql_client.escape(table)} (
+                                   uid  INT(11) NOT NULL AUTO_INCREMENT PRIMARY KEY
+                      );"
+end
+
+Given(/^drop the database table `(.*)`/) do |table|
+  mysql_client = instantiate_mysql_client @database_name
+  mysql_client.query "DROP Table #{mysql_client.escape(table)};"
+end
+
+Then(/^the database (should|should not) have a table `(.*)`$/) do |should_or_not, table|
+  mysql_client = instantiate_mysql_client
+  query_string = "SELECT `TABLE_NAME`
+                    FROM `information_schema`.`TABLES`
+                   WHERE `TABLE_SCHEMA` = '#{mysql_client.escape(@database_name)}'
+                     AND `TABLE_NAME` = '#{mysql_client.escape(table)}';"
+  results = mysql_client.query query_string
+  number_of_columns = results.count
+  expectation = should_or_not == 'should' ? 1 : 0
+  expect(number_of_columns).to eq expectation
+end

data/features/step_definitions/typo3.rb

@@ -0,0 +1,16 @@
+Given(/^a successfully deployed TYPO3 application$/) do
+  step 'I want to use the database `dkdeploy_typo3_cms`'
+  step 'the TYPO3 table be_users exists'
+  step 'a TYPO3 backend user "_cli_lowlevel" exists'
+  step 'I successfully run `cap dev composer:local:run[install]` for up to 60 seconds'
+  step 'I successfully run `cap dev db:upload_settings[127.0.0.1,3306,dkdeploy_typo3_cms,root,ilikerandompasswords,utf8]`'
+  step 'I successfully run `cap dev typo3:cms:create_db_credentials`'
+  step 'I successfully run `cap dev typo3:cms:create_install_tool_password_file[dkdeploy]`'
+  step 'I successfully run `cap dev typo3:cms:create_encryption_key_file[ca01b5b9868677647d3ec6c91b6b338a34786d6d4e163fb44badde98d11c9f887a5567a1d7797847de011693c36e110f]`'
+  step 'I successfully run `cap dev deploy`'
+  step 'I successfully run `cap dev typo3:cms:setup_additional_configuration`'
+  step 'I successfully run `cap dev typo3:cms:update_database`'
+  step 'I successfully run `cap dev file_access:set_permissions_of_release_path`'
+  step 'I successfully run `cap dev file_access:set_permissions_of_shared_path`'
+  step 'I successfully run `cap dev file_access:set_custom_access`'
+end

data/features/support/env.rb

@@ -0,0 +1,11 @@
+require 'dkdeploy/test_environment/application'
+ssh_config = {}
+
+ssh_key_files = Dir.glob(File.join(Dir.getwd, '.vagrant', 'machines', '**', 'virtualbox', 'private_key'))
+unless ssh_key_files.empty?
+  # Define generated ssh key files
+  ssh_config = { user: 'vagrant', keys: ssh_key_files }
+end
+
+TEST_APPLICATION = Dkdeploy::TestEnvironment::Application.new(File.expand_path('../../../', __FILE__), 'dkdeploy-typo3-cms.dev', ssh_config)
+TEST_APPLICATION.mysql_connection_settings = { host: 'dkdeploy-typo3-cms.dev', username: 'root', password: 'ilikerandompasswords' }

data/features/typo3.feature

@@ -0,0 +1,100 @@
+Feature: Test tasks for namespace 'typo3:cms'
+
+	Background:
+		Given a test app with the default configuration
+		And the remote server is cleared
+
+	Scenario: Toggle TYPO3 Install Tool
+		When I successfully run `cap dev typo3:cms:enable_install_tool`
+		Then a remote file named "current_path/typo3conf/ENABLE_INSTALL_TOOL" should exist
+		When I successfully run `cap dev typo3:cms:disable_install_tool`
+		Then a remote file named "current_path/typo3conf/ENABLE_INSTALL_TOOL" should not exist
+
+	Scenario: Clear typo3temp
+		Given a remote empty file named "release_path/typo3temp/testdirectory/file.png"
+		When I successfully run `cap dev typo3:cms:clear_typo3temp`
+		Then a remote directory named "current_path/typo3temp/testdirectory" should not exist
+		And a remote file named "current_path/typo3temp/testdirectory/file.png" should not exist
+
+	Scenario: Fetch extension if it exists
+		And the project is deployed
+		Given a remote empty file named "current_path/typo3conf/ext/demo/extension.php"
+		And a remote directory named "current_path/typo3conf/ext/demo/.git/gitRemote"
+		And a remote directory named "current_path/typo3conf/ext/demo/.svn/svnRemote"
+		And an empty file named "htdocs/typo3conf/ext/demo/toBeDeleted.php"
+		And an empty file named "htdocs/typo3conf/ext/demo/.git/gitOriginal"
+		And an empty file named "htdocs/typo3conf/ext/demo/.svn/svnOriginal"
+		When I run `cap dev typo3:cms:fetch_extension` interactively
+		And I type "demo"
+		And I close the stdin stream
+		Then the exit status should be 0
+		When I wait 5 seconds to let the filesystem write the changes to disk
+		Then a file named "htdocs/typo3conf/ext/demo/extension.php" should exist
+		And a file named "htdocs/typo3conf/ext/demo/toBeDeleted.php" should not exist
+		And a file named "htdocs/typo3conf/ext/demo/.git/gitOriginal" should exist
+		And a file named "htdocs/typo3conf/ext/demo/.git/gitRemote" should not exist
+		And a file named "htdocs/typo3conf/ext/demo/.svn/svnOriginal" should exist
+		And a file named "htdocs/typo3conf/ext/demo/.svn/svnRemote" should not exist
+
+	Scenario: Fetch extension if it does not exist
+		Given a remote empty file named "current_path/typo3conf/ext/demo/extension.php"
+		Then a remote file named "current_path/typo3conf/ext/demo/extension.php" should exist
+		When I run `cap dev typo3:cms:fetch_extension` interactively
+		And I type "cowabonga"
+		And I close the stdin stream
+		Then the output should contain "Extension 'cowabonga' not found!"
+
+	Scenario: Check creation of TYPO3 database config file
+		Given I want to use the database `dkdeploy_typo3_cms`
+		When I successfully run `cap dev "db:upload_settings[127.0.0.1,3306,dkdeploy,root,ilikerandompasswords,utf8]"`
+		When I successfully run `cap dev typo3:cms:create_db_credentials`
+		Then a remote file named "shared_path/config/db_settings.dev.php" should exist
+
+	Scenario: Check creation of TYPO3 database config file even if remote database config does not exist
+		Given I want to use the database `dkdeploy_typo3_cms`
+		Then a remote file named "shared_path/config/db_settings.dev.php" should not exist
+		When I run `cap dev typo3:cms:create_db_credentials` interactively
+		And I type "127.0.0.1"
+		And I type "3306"
+		And I type "dkdeploy_typo3_cms"
+		And I type "root"
+		And I type "ilikerandompasswords"
+		And I type "utf8"
+		And I close the stdin stream
+		Then the exit status should be 0
+		Then a remote file named "shared_path/config/db_settings.dev.php" should exist
+
+	Scenario: Check generation of encryption key
+		When I successfully run `cap dev typo3:cms:generate_encryption_key`
+		Then the output should match /[0-9a-fA-F]{80}/
+
+	Scenario: Check creation of encryption key file on server
+		When I successfully run `cap dev "typo3:cms:create_encryption_key_file[my-encryption-key]"`
+		Then the remote file "shared_path/config/encryption_key.php" should contain exactly:
+		"""
+		<?php $GLOBALS['TYPO3_CONF_VARS']['SYS']['encryptionKey'] = 'my-encryption-key';
+		"""
+
+	Scenario: Check creation of TYPO3 Install Tool password
+		When I successfully run `cap dev "typo3:cms:create_install_tool_password_file[super-secret-password]"`
+		Then a remote file named "shared_path/config/install_tool_password.php" should exist
+
+	Scenario: Check adding a TYPO3 admin user
+		Given I want to use the database `dkdeploy_typo3_cms`
+		Given the TYPO3 table be_users exists
+		When I run `cap dev typo3:cms:create_db_credentials` interactively
+		And I type "127.0.0.1"
+		And I type "3306"
+		And I type "dkdeploy_typo3_cms"
+		And I type "root"
+		And I type "ilikerandompasswords"
+		And I type "utf8"
+		And I close the stdin stream
+		Then the exit status should be 0
+		When I run `cap dev typo3:cms:add_admin_user` interactively
+		And I type "admin"
+		And I type "secret-password"
+		And I close the stdin stream
+		And I wait 10 second to let the database commit the transaction
+		Then the database should have a value `admin` in table `be_users` for column `username`
+		Then the database should have a value `2304d4770a72d09106045fea654c4188` in table `be_users` for column `password`