Add remaining vagrant/ansible needs.

cakephp · Dec 1, 2016 · 90374fa · 90374fa
1 parent d9e2b3d
commit 90374fa
Show file tree

Hide file tree

Showing 6 changed files with 346 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -12,3 +12,28 @@ the [bookmarker tutorial](http://book.cakephp.org/3.0/en/quickstart.html).
 5. Configure your database credentials in ``app.php``. Make sure to use the same database name as in step 4.
 6. Start the server `bin/cake server -p 8765`.
 7. Go to http://localhost:8765 in your browser.
+
+# Using Vagrant
+
+If you don't have a local development environment setup, you can use Vagrant to
+create one. After installing Vagrant run:
+
+```
+vagrant up
+```
+
+This will download a new vagrant image, and run ansible to provision the
+bookmarking application. Once ansible is complete, you should have a working
+application available at http://192.168.33.99 .
+
+### Logging In
+
+You can login to the application at http://192.168.33.99/users/login. The
+username is `[email protected]` and the password is `password`.
+
+## Before you run Ansible a second time
+
+After the initial provisioning run if you want to re-run ansible, make sure to
+remove `mysql.dump` in `ansible/vars/all.yml` or ansible will reset your
+database state to whats in the SQL dump file.
+
diff --git a/ansible/roles/app/tasks/main.yml b/ansible/roles/app/tasks/main.yml
@@ -1,2 +1,12 @@
 ---
-# application tasks to be customized and to run after the main provision
+- name: Create web app config file.
+  template:
+  args:
+    src: app.php.tpl
+    dest: "/vagrant/config/app.php"
+
+- name: Install composer dependencies
+  command: "composer install --no-interactive"
+  args:
+    creates: "/vagrant/vendor/autoload.php"
+    chdir: "/vagrant"
diff --git a/ansible/roles/app/templates/app.php.tpl b/ansible/roles/app/templates/app.php.tpl
@@ -0,0 +1,299 @@
+<?php
+return [
+    /**
+     * Debug Level:
+     *
+     * Production Mode:
+     * false: No error messages, errors, or warnings shown.
+     *
+     * Development Mode:
+     * true: Errors and warnings shown.
+     */
+    'debug' => true,
+
+    /**
+     * Configure basic information about the application.
+     *
+     * - namespace - The namespace to find app classes under.
+     * - encoding - The encoding used for HTML + database connections.
+     * - base - The base directory the app resides in. If false this
+     *   will be auto detected.
+     * - dir - Name of app directory.
+     * - webroot - The webroot directory.
+     * - wwwRoot - The file path to webroot.
+     * - baseUrl - To configure CakePHP to *not* use mod_rewrite and to
+     *   use CakePHP pretty URLs, remove these .htaccess
+     *   files:
+     *      /.htaccess
+     *      /webroot/.htaccess
+     *   And uncomment the baseUrl key below.
+     * - fullBaseUrl - A base URL to use for absolute links.
+     * - imageBaseUrl - Web path to the public images directory under webroot.
+     * - cssBaseUrl - Web path to the public css directory under webroot.
+     * - jsBaseUrl - Web path to the public js directory under webroot.
+     * - paths - Configure paths for non class based resources. Supports the
+     *   `plugins`, `templates`, `locales` subkeys, which allow the definition of
+     *   paths for plugins, view templates and locale files respectively.
+     */
+    'App' => [
+        'namespace' => 'App',
+        'encoding' => 'UTF-8',
+        'base' => false,
+        'dir' => 'src',
+        'webroot' => 'webroot',
+        'wwwRoot' => WWW_ROOT,
+        // 'baseUrl' => env('SCRIPT_NAME'),
+        'fullBaseUrl' => false,
+        'imageBaseUrl' => 'img/',
+        'cssBaseUrl' => 'css/',
+        'jsBaseUrl' => 'js/',
+        'paths' => [
+            'plugins' => [ROOT . DS . 'plugins' . DS],
+            'templates' => [APP . 'Template' . DS],
+            'locales' => [APP . 'Locale' . DS],
+        ],
+    ],
+
+    /**
+     * Security and encryption configuration
+     *
+     * - salt - A random string used in security hashing methods.
+     *   The salt value is also used as the encryption key.
+     *   You should treat it as extremely sensitive data.
+     */
+    'Security' => [
+        'salt' => '{{ app.salt }}',
+    ],
+
+    /**
+     * Apply timestamps with the last modified time to static assets (js, css, images).
+     * Will append a querystring parameter containing the time the file was modified.
+     * This is useful for busting browser caches.
+     *
+     * Set to true to apply timestamps when debug is true. Set to 'force' to always
+     * enable timestamping regardless of debug value.
+     */
+    'Asset' => [
+        // 'timestamp' => true,
+    ],
+
+    /**
+     * Configure the cache adapters.
+     */
+    'Cache' => [
+        'default' => [
+            'className' => 'File',
+            'path' => CACHE,
+        ],
+
+        /**
+         * Configure the cache used for general framework caching. Path information,
+         * object listings, and translation cache files are stored with this
+         * configuration.
+         */
+        '_cake_core_' => [
+            'className' => 'File',
+            'prefix' => 'myapp_cake_core_',
+            'path' => CACHE . 'persistent/',
+            'serialize' => true,
+            'duration' => '+2 minutes',
+        ],
+
+        /**
+         * Configure the cache for model and datasource caches. This cache
+         * configuration is used to store schema descriptions, and table listings
+         * in connections.
+         */
+        '_cake_model_' => [
+            'className' => 'File',
+            'prefix' => 'myapp_cake_model_',
+            'path' => CACHE . 'models/',
+            'serialize' => true,
+            'duration' => '+2 minutes',
+        ],
+    ],
+
+    /**
+     * Configure the Error and Exception handlers used by your application.
+     *
+     * By default errors are displayed using Debugger, when debug is true and logged
+     * by Cake\Log\Log when debug is false.
+     *
+     * In CLI environments exceptions will be printed to stderr with a backtrace.
+     * In web environments an HTML page will be displayed for the exception.
+     * With debug true, framework errors like Missing Controller will be displayed.
+     * When debug is false, framework errors will be coerced into generic HTTP errors.
+     *
+     * Options:
+     *
+     * - `errorLevel` - int - The level of errors you are interested in capturing.
+     * - `trace` - boolean - Whether or not backtraces should be included in
+     *   logged errors/exceptions.
+     * - `log` - boolean - Whether or not you want exceptions logged.
+     * - `exceptionRenderer` - string - The class responsible for rendering
+     *   uncaught exceptions.  If you choose a custom class you should place
+     *   the file for that class in src/Error. This class needs to implement a
+     *   render method.
+     * - `skipLog` - array - List of exceptions to skip for logging. Exceptions that
+     *   extend one of the listed exceptions will also be skipped for logging.
+     *   E.g.:
+     *   `'skipLog' => ['Cake\Network\Exception\NotFoundException', 'Cake\Network\Exception\UnauthorizedException']`
+     */
+    'Error' => [
+        'errorLevel' => E_ALL & ~E_DEPRECATED,
+        'exceptionRenderer' => 'Cake\Error\ExceptionRenderer',
+        'skipLog' => [],
+        'log' => true,
+        'trace' => true,
+    ],
+
+    /**
+     * Email configuration.
+     *
+     * By defining transports separately from delivery profiles you can easily
+     * re-use transport configuration across multiple profiles.
+     *
+     * You can specify multiple configurations for production, development and
+     * testing.
+     *
+     * Each transport needs a `className`. Valid options are as follows:
+     *
+     *  Mail   - Send using PHP mail function
+     *  Smtp   - Send using SMTP
+     *  Debug  - Do not send the email, just return the result
+     *
+     * You can add custom transports (or override existing transports) by adding the
+     * appropriate file to src/Network/Email.  Transports should be named
+     * 'YourTransport.php', where 'Your' is the name of the transport.
+     */
+    'EmailTransport' => [
+        'default' => [
+            'className' => 'Mail',
+            // The following keys are used in SMTP transports
+            'host' => 'localhost',
+            'port' => 25,
+            'timeout' => 30,
+            'username' => 'user',
+            'password' => 'secret',
+            'client' => null,
+            'tls' => null,
+        ],
+    ],
+
+    /**
+     * Email delivery profiles
+     *
+     * Delivery profiles allow you to predefine various properties about email
+     * messages from your application and give the settings a name. This saves
+     * duplication across your application and makes maintenance and development
+     * easier. Each profile accepts a number of keys. See `Cake\Network\Email\Email`
+     * for more information.
+     */
+    'Email' => [
+        'default' => [
+            'transport' => 'default',
+            'from' => 'you@localhost',
+            //'charset' => 'utf-8',
+            //'headerCharset' => 'utf-8',
+        ],
+    ],
+
+    /**
+     * Connection information used by the ORM to connect
+     * to your application's datastores.
+     * Drivers include Mysql Postgres Sqlite Sqlserver
+     * See vendor\cakephp\cakephp\src\Database\Driver for complete list
+     */
+    'Datasources' => [
+        'default' => [
+            'className' => 'Cake\Database\Connection',
+            'driver' => 'Cake\Database\Driver\Mysql',
+            'persistent' => false,
+            'host' => 'localhost',
+            'username' => '{{ mysql.user }}',
+            'password' => '{{ mysql.password }}',
+            'database' => '{{ mysql.database }}',
+            'encoding' => 'utf8',
+            'timezone' => 'UTC',
+            'cacheMetadata' => true,
+            'quoteIdentifiers' => false,
+        ],
+
+        /**
+         * The test connection is used during the test suite.
+         */
+        'test' => [
+            'className' => 'Cake\Database\Connection',
+            'driver' => 'Cake\Database\Driver\Mysql',
+            'persistent' => false,
+            'host' => 'localhost',
+            'username' => '{{ mysql.user }}',
+            'password' => '{{ mysql.password }}',
+            'database' => 'test',
+            'encoding' => 'utf8',
+            'timezone' => 'UTC',
+            'cacheMetadata' => true,
+            'quoteIdentifiers' => false,
+        ],
+    ],
+
+    /**
+     * Configures logging options
+     */
+    'Log' => [
+        'debug' => [
+            'className' => 'Cake\Log\Engine\FileLog',
+            'path' => LOGS,
+            'file' => 'debug',
+            'levels' => ['notice', 'info', 'debug'],
+        ],
+        'error' => [
+            'className' => 'Cake\Log\Engine\FileLog',
+            'path' => LOGS,
+            'file' => 'error',
+            'levels' => ['warning', 'error', 'critical', 'alert', 'emergency'],
+        ],
+    ],
+
+    /**
+     * Session configuration.
+     *
+     * Contains an array of settings to use for session configuration. The
+     * `defaults` key is used to define a default preset to use for sessions, any
+     * settings declared here will override the settings of the default config.
+     *
+     * ## Options
+     *
+     * - `cookie` - The name of the cookie to use. Defaults to 'CAKEPHP'.
+     * - `cookiePath` - The url path for which session cookie is set. Maps to the
+     *   `session.cookie_path` php.ini config. Defaults to base path of app.
+     * - `timeout` - The time in minutes the session should be valid for.
+     *    Pass 0 to disable checking timeout.
+     *    Please note that php.ini's session.gc_maxlifetime must be equal to or greater
+     *    than the largest Session['timeout'] in all served websites for it to have the
+     *    desired effect.
+     * - `defaults` - The default configuration set to use as a basis for your session.
+     *    There are four built-in options: php, cake, cache, database.
+     * - `handler` - Can be used to enable a custom session handler. Expects an
+     *    array with at least the `engine` key, being the name of the Session engine
+     *    class to use for managing the session. CakePHP bundles the `CacheSession`
+     *    and `DatabaseSession` engines.
+     * - `ini` - An associative array of additional ini values to set.
+     *
+     * The built-in `defaults` options are:
+     *
+     * - 'php' - Uses settings defined in your php.ini.
+     * - 'cake' - Saves session files in CakePHP's /tmp directory.
+     * - 'database' - Uses CakePHP's database sessions.
+     * - 'cache' - Use the Cache class to save sessions.
+     *
+     * To define a custom session handler, save it at src/Network/Session/<name>.php.
+     * Make sure the class implements PHP's `SessionHandlerInterface` and set
+     * Session.handler to <name>
+     *
+     * To use database sessions, load the SQL file located at config/Schema/sessions.sql
+     */
+    'Session' => [
+        'defaults' => 'php',
+    ],
+];
diff --git a/ansible/roles/server/tasks/main.yml b/ansible/roles/server/tasks/main.yml
@@ -10,6 +10,7 @@
     - curl
     - wget
     - python-software-properties
+    - zip
 
 - name: Install Extra Packages
   sudo: yes

diff --git a/ansible/vars/all.yml b/ansible/vars/all.yml
@@ -20,6 +20,9 @@ mysql:
 php:
     install: '1'
     ppa: php
-    packages: [php5.6-cli, php5.6-intl, php5.6-mcrypt, php5.6-mysql]
+    packages: [php5.6-cli, php5.6-intl, php5.6-mcrypt, php5.6-mysql, php5.6-mbstring]
 composer:
     install: '1'
+app:
+  salt: f554f132cf42fb542d5d54489dd97d82c36e788d9d025fdb4ca6877802b4e1a2
+
diff --git a/config/schema/app.sql b/config/schema/app.sql
@@ -1,3 +1,9 @@
+-- Reset state
+DROP TABLE IF EXISTS bookmarks_tags;
+DROP TABLE IF EXISTS bookmarks;
+DROP TABLE IF EXISTS tags;
+DROP TABLE IF EXISTS users;
+
 CREATE TABLE users (
     id INT AUTO_INCREMENT PRIMARY KEY,
     email VARCHAR(255) NOT NULL,
@@ -33,7 +39,6 @@ CREATE TABLE bookmarks_tags (
     FOREIGN KEY bookmark_key(bookmark_id) REFERENCES bookmarks(id)
 );
 
-
 -- Insert Sample Data
 INSERT INTO `users` VALUES (1,'[email protected]','$2y$10$mC71iGlr.MzYoueQDoOmcOHIq3621JHfUhLy.jT2fvH2fx.6ACwou','2016-12-01 03:10:35','2016-12-01 03:10:35');
-Original file line number
+Diff line change
@@ Expand Up / @@ -10,6 +10,7 @@ @@
         - curl
         - wget
         - python-software-properties
+        - zip
     - name: Install Extra Packages
       sudo: yes
@@ Expand Down @@