You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@aurora.apache.org by dl...@apache.org on 2014/10/31 02:11:11 UTC
svn commit: r1635650 - in /incubator/aurora/site:
publish/documentation/latest/test-resource-generation/
publish/documentation/latest/test-resource-generation/index.html
source/documentation/latest/test-resource-generation.md
Author: dlester
Date: Fri Oct 31 01:11:10 2014
New Revision: 1635650
URL: http://svn.apache.org/r1635650
Log:
Adds test resource generation documentation.
Added:
incubator/aurora/site/publish/documentation/latest/test-resource-generation/
incubator/aurora/site/publish/documentation/latest/test-resource-generation/index.html
incubator/aurora/site/source/documentation/latest/test-resource-generation.md
Added: incubator/aurora/site/publish/documentation/latest/test-resource-generation/index.html
URL: http://svn.apache.org/viewvc/incubator/aurora/site/publish/documentation/latest/test-resource-generation/index.html?rev=1635650&view=auto
==============================================================================
--- incubator/aurora/site/publish/documentation/latest/test-resource-generation/index.html (added)
+++ incubator/aurora/site/publish/documentation/latest/test-resource-generation/index.html Fri Oct 31 01:11:10 2014
@@ -0,0 +1,134 @@
+<html>
+ <head>
+ <meta charset="utf-8">
+ <title>Apache Aurora</title>
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+ <meta name="description" content="">
+ <meta name="author" content="">
+
+ <link href="/assets/css/bootstrap.css" rel="stylesheet">
+ <link href="/assets/css/bootstrap-responsive.min.css" rel="stylesheet">
+ <link href="/assets/css/main.css" rel="stylesheet">
+
+ <!-- JS -->
+ <script type="text/javascript" src="/assets/js/jquery-1.10.1.min.js"></script>
+ <script type="text/javascript" src="/assets/js/bootstrap-dropdown.js"></script>
+
+ <!-- Analytics -->
+ <script type="text/javascript">
+ var _gaq = _gaq || [];
+ _gaq.push(['_setAccount', 'UA-45879646-1']);
+ _gaq.push(['_setDomainName', 'apache.org']);
+ _gaq.push(['_trackPageview']);
+
+ (function() {
+ var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
+ ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
+ var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
+ })();
+ </script>
+ </head>
+ <body>
+ <div class="navbar navbar-static-top">
+ <div class="navbar-inner">
+ <div class="container">
+ <a href="/" class="logo"><img src="/assets/img/aurora_logo.png" alt="Apache Aurora logo" /></a>
+ <ul class="nav">
+ <li><a href="/documentation/latest/">Documentation</a></li>
+ <li><a href="/downloads/">Download</a></li>
+ <li><a href="/community">Community</a></li>
+ </ul>
+ </div>
+ </div>
+</div>
+
+<div class="container">
+<!-- magical breadcrumbs -->
+<ul class="breadcrumb">
+ <li>
+ <div class="dropdown">
+ <a class="dropdown-toggle" data-toggle="dropdown" href="#">Apache Software Foundation <b class="caret"></b></a>
+ <ul class="dropdown-menu" role="menu">
+ <li><a href="http://www.apache.org">Apache Homepage</a></li>
+ <li><a href="http://www.apache.org/licenses/">Apache License</a></li>
+ <li><a href="http://www.apache.org/foundation/sponsorship.html">Sponsorship</a></li>
+ <li><a href="http://www.apache.org/foundation/thanks.html">Thanks</a></li>
+ <li><a href="http://www.apache.org/security/">Security</a></li>
+ </ul>
+ </div>
+ </li>
+ <li><span class="divider">•</span></li>
+ <li><a href="http://incubator.apache.org">Apache Incubator</a></li>
+ <li><span class="divider">•</span></li>
+ <li><a href="http://aurora.incubator.apache.org">Apache Aurora</a></li>
+</ul>
+<!-- /breadcrumb -->
+
+ <div class="container">
+ <h1 id="generating-test-resources">Generating test resources</h1>
+
+<h2 id="background">Background</h2>
+
+<p>The Aurora source repository and distributions contain several
+<a href="../src/test/resources/org/apache/thermos/root/checkpoints">binary files</a> to
+qualify the backwards-compatibility of thermos with checkpoint data. Since
+thermos persists state to disk, to be read by other components (the GC executor
+and the thermos observer), it is important that we have tests that prevent
+regressions affecting the ability to parse previously-written data.</p>
+
+<h2 id="generating-test-files">Generating test files</h2>
+
+<p>The files included represent persisted checkpoints that exercise different
+features of thermos. The existing files should not be modified unless
+we are accepting backwards incompatibility, such as with a major release.</p>
+
+<p>It is not practical to write source code to generate these files on the fly,
+as source would be vulnerable to drift (e.g. due to refactoring) in ways
+that would undermine the goal of ensuring backwards compatibility.</p>
+
+<p>The most common reason to add a new checkpoint file would be to provide
+coverage for new thermos features that alter the data format. This is
+accomplished by writing and running a
+<a href="/documentation/latest/configuration-reference/">job configuration</a> that exercises the feature, and
+copying the checkpoint file from the sandbox directory, by default this is
+<code>/var/run/thermos/checkpoints/<aurora task id></code>.</p>
+
+ </div>
+ <div class="container">
+ <hr>
+ <footer class="footer">
+ <div class="row-fluid">
+ <div class="span2 text-left">
+ <h3>Links</h3>
+ <ul class="unstyled">
+ <li><a href="/downloads/">Downloads</a></li>
+ <li><a href="/developers/">Developers</a></li>
+ </ul>
+ </div>
+ <div class="span3 text-left">
+ <h3>Community</h3>
+ <ul class="unstyled">
+ <li><a href="/community/">Mailing Lists</a></li>
+ <li><a href="http://issues.apache.org/jira/browse/aurora">Issue Tracking</a></li>
+ <li><a href="/docs/howtocontribute/">How To Contribute</a></li>
+ </ul>
+ </div>
+ <div class="span7 text-left">
+ <h3>Apache Software Foundation</h3>
+
+ <div class="span8">
+ Copyright 2014 <a href="http://www.apache.org/">Apache Software Foundation</a>. Licensed under the <a href="http://www.apache.org/licenses/">Apache License v2.0</a>. Apache, Apache Thrift, and the Apache feather logo are trademarks of The Apache Software Foundation. Currently part of the <a href="http://incubator.apache.org">Apache Incubator</a>.
+ </div>
+ <div class=" pull-right">
+ <a href="http://incubator.apache.org" class="logo"><img src="/assets/img/apache_incubator_logo.png" alt="Apache Incubator" class="pull-right"/></a>
+ </div>
+ </div>
+
+ </div>
+
+ </footer>
+</div>
+
+ </body>
+</html>
+
Added: incubator/aurora/site/source/documentation/latest/test-resource-generation.md
URL: http://svn.apache.org/viewvc/incubator/aurora/site/source/documentation/latest/test-resource-generation.md?rev=1635650&view=auto
==============================================================================
--- incubator/aurora/site/source/documentation/latest/test-resource-generation.md (added)
+++ incubator/aurora/site/source/documentation/latest/test-resource-generation.md Fri Oct 31 01:11:10 2014
@@ -0,0 +1,25 @@
+# Generating test resources
+
+## Background
+The Aurora source repository and distributions contain several
+[binary files](../src/test/resources/org/apache/thermos/root/checkpoints) to
+qualify the backwards-compatibility of thermos with checkpoint data. Since
+thermos persists state to disk, to be read by other components (the GC executor
+and the thermos observer), it is important that we have tests that prevent
+regressions affecting the ability to parse previously-written data.
+
+## Generating test files
+The files included represent persisted checkpoints that exercise different
+features of thermos. The existing files should not be modified unless
+we are accepting backwards incompatibility, such as with a major release.
+
+It is not practical to write source code to generate these files on the fly,
+as source would be vulnerable to drift (e.g. due to refactoring) in ways
+that would undermine the goal of ensuring backwards compatibility.
+
+The most common reason to add a new checkpoint file would be to provide
+coverage for new thermos features that alter the data format. This is
+accomplished by writing and running a
+[job configuration](/documentation/latest/configuration-reference/) that exercises the feature, and
+copying the checkpoint file from the sandbox directory, by default this is
+`/var/run/thermos/checkpoints/<aurora task id>`.