Helix SwarmHelix Swarm
Loading...

overview.html

  • //
  • guest/
  • tjuricek/
  • initializer/
  • docs/
  • site/
  • overview.html #4
  • View
  • Commits
  • Open Download .zip Download (6 KB) 
  1. <!DOCTYPE html>
  2. <html lang="en">
  3.   <head>
  4.     <meta charset="utf-8"/>
  5.     <title>Initializer for Perforce Servers</title>
  6.     <meta name="viewport" content="width=device-width, initial-scale=1.0">
  7.     <meta name="description" content="">
  8.     <meta name="author" content="">
  9.     <meta name="keywords" content="">
  10.     <meta name="generator" content"JBake">
  11.  
  12.     <!-- Le styles -->
  13.     <link href="css/bootstrap.min.css" rel="stylesheet">
  14.     <link href="css/asciidoctor.css" rel="stylesheet">
  15.     <link href="css/base.css" rel="stylesheet">
  16.     <link href="css/bootstrap-responsive.min.css" rel="stylesheet">
  17.  
  18.     <!-- HTML5 shim, for IE6-8 support of HTML5 elements -->
  19.     <!--[if lt IE 9]>
  20.       <script src="js/html5shiv.js"></script>
  21.     <![endif]-->
  22.  
  23.     <!-- Fav and touch icons -->
  24.     <!--<link rel="apple-touch-icon-precomposed" sizes="144x144" href="../assets/ico/apple-touch-icon-144-precomposed.png">
  25.     <link rel="apple-touch-icon-precomposed" sizes="114x114" href="../assets/ico/apple-touch-icon-114-precomposed.png">
  26.     <link rel="apple-touch-icon-precomposed" sizes="72x72" href="../assets/ico/apple-touch-icon-72-precomposed.png">
  27.     <link rel="apple-touch-icon-precomposed" href="../assets/ico/apple-touch-icon-57-precomposed.png">-->
  28.     <link rel="shortcut icon" href="favicon.ico">
  29.   </head>
  30.   <body>
  31.     <div id="wrap">
  32.  
  33. <nav class="navbar navbar-default" role="navigation">
  34.     <div class="container-fluid">
  35.         <div class="navbar-header">
  36.             <ul class="nav navbar-nav">
  37.                 <li><a href="index.html">Initializer</a></li>
  38.                 <li><a href="overview.html">Overview</a></li>
  39.                 <li><a href="data.html">Data</a></li>
  40.                 <li><a href="../javadoc/index.html">Javadoc</a></li>
  41.             </ul>
  42.         </div>
  43.     </div>
  44. </nav>
  45.  
  46. <div class="container">
  47.  
  48. <h1>Initializer Overview</h1><p>When developing applications on top of the Perforce server, you often want to start with a server with real data in a sensible configuration. When these apps need to run against <em>multiple versions</em> of Perforce, you're faced with figuring out how to set up each instance in the same way. This is the job of the initializer: take a bunch of files and metadata, and set up your Perforce instance. Now, you can, say, run the same system tests in different configurations of Perforce.</p><p>The initializer uses a directory of .json files that describe changes to be made, along with versions of data to "seed" into the system. See the <a href="data.html">Data</a> page for details of how to set this up. This directory is intended to be checked in with your system tests.</p><p>When you have the data set up, you'll then execute the initializer either using the command line, or, via gradle plugins. Both of these options are described below.</p><h2>Requirements</h2>
  49. <ol>
  50.   <li><p>Java 8</p></li>
  51.   <li><p>A running Perforce instance, this tool does not actually download the p4d executable, and generally assumes you've just set it up without a lot of configuration</p></li>
  52. </ol><h2>Notable Restrictions</h2><p>This system always sets security to level 2 at the moment.</p><h2>Executing using the Command Line</h2><p>The first part of executing via the command line is downloading the "complete" jar distribution.</p><p><a href="http://dl.bintray.com/tristanjuricek/generic/initializer/0.1.2/#initializer-complete.jar">Version 0.1.2</a></p><h3>Create A Configuration File</h3><p>From here, you'll need to create a configuration file. Here's an example:</p>
  53. <pre><code>options:
  54.     dataRootDir:    src/test/perforce
  55.     triggersDir:    build/perforce/work/triggers
  56.     clientRootDir:  build/perforce/clients
  57. </code></pre><p>This is a <a href="http://yaml.org">YAML</a> file, so save this content in a file like <code>config.yml</code>.</p><p>The main directory you need is <code>dataRootDir</code>. This is the <a href="data.html">data directory tree</a> contains all your JSON files and data to be seeded.</p><p>The <code>triggersDir</code> is used only if you're creating triggers; this is the directory we write out the trigger file for use by the Perforce instance.</p><p>The <code>clientRootDir</code> is used by all temporary clients as a working area.</p><p>Note that this assumes a Perforce instance is running on localhost:1666. If this is not the case, you'll need an additional section in the config file:</p>
  58. <pre><code>connectionSettings:
  59.     hostname:   localhost
  60.     port:       1666
  61. </code></pre><h3>Execution</h3><p>Execute downloaded jar file with your configuration:</p>
  62. <pre><code>% java -jar initializer-complete.jar config.yml
  63. </code></pre><h2>Executing using Gradle</h2><p>First, set up your <code>buildscript</code> repository configuration for both the <code>initializer-gradle-plugin</code> and the <code>perforce-gradle-plugin</code>:</p>
  64. <pre><code>buildscript {
  65.     repositories {
  66.         jcenter()
  67.     }
  68.     dependencies {
  69.         classpath(&quot;com.perforce.workshop.tjuricek:perforce-gradle-plugin:0.1.2&quot;)
  70.         classpath(&quot;com.perforce.workshop.tjuricek:initializer-gradle-plugin:0.1.1&quot;)
  71.     }
  72. }
  73. </code></pre><p>Then, just apply the plugins:</p>
  74. <pre><code>apply plugin: &#39;perforce&#39;
  75. apply plugin: &#39;perforce-initializer&#39;
  76. </code></pre><p>You'll only need to then run the <code>initPerforce</code> task once:</p>
  77. <pre><code>% ./gradlew initPerforce
  78. </code></pre><p>From there, you can start and stop the test server using <code>stopPerforce</code> and <code>startPerforce</code> tasks.</p><p>This assumes that by default you've stored all your data under the <code>src/test/perforce</code>. You can reconfigure this:</p>
  79. <pre><code>initializer {
  80.     sources = project.file(&#39;another/directory&#39;)
  81. }
  82. </code></pre>
  83.  
  84. </div>
  85.  
  86.     </div><!-- #wrap -->
  87.  
  88.     <!-- Le javascript
  89.     ================================================== -->
  90.     <!-- Placed at the end of the document so the pages load faster -->
  91.     <script src="js/jquery-1.11.1.min.js"></script>
  92.     <script src="js/bootstrap.min.js"></script>
  93.     <script src="js/run_prettify.js"></script>
  94.  
  95.   </body>
  96. </html>
# Change User Description Committed
#4 9174 tjuricek Fix header 11 years ago
#3 9173 tjuricek Added gradle instructions and removed hideous footer in site documentation. 11 years ago
#2 9172 tjuricek 0.1.2 Added command line execution options and documentation to run the initializer locall...y. « 11 years ago
#1 9165 tjuricek Some documentation framework and a fatjar style distribution for the initializer to run ou...tside of a gradle plugin.

Upped the version to 0.1.2, but this may need some testing before it's really guaranteed to work in standalone mode «		 11 years ago