Added: cassandra/site/publish/doc/3.7/development/index.html URL: http://svn.apache.org/viewvc/cassandra/site/publish/doc/3.7/development/index.html?rev=1758606&view=auto ============================================================================== --- cassandra/site/publish/doc/3.7/development/index.html (added) +++ cassandra/site/publish/doc/3.7/development/index.html Wed Aug 31 13:51:55 2016 @@ -0,0 +1,289 @@ +<!DOCTYPE html> +<html> + + + + +<head> + <meta charset="utf-8"> + <meta http-equiv="X-UA-Compatible" content="IE=edge"> + <meta name="viewport" content="width=device-width, initial-scale=1"> + <meta name="description" content="The Apache Cassandra database is the right choice when you need scalability and high availability without compromising performance. Linear scalability and proven fault-tolerance on commodity hardware or cloud infrastructure make it the perfect platform for mission-critical data. Cassandra's support for replicating across multiple datacenters is best-in-class, providing lower latency for your users and the peace of mind of knowing that you can survive regional outages. +"> + <meta name="keywords" content="cassandra, apache, apache cassandra, distributed storage, key value store, scalability, bigtable, dynamo" /> + <meta name="robots" content="index,follow" /> + <meta name="language" content="en" /> + + <title>Documentation</title> + + <link rel="canonical" href="http://cassandra.apache.org/doc/3.7/development/";> + + <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.6/css/bootstrap.min.css"; integrity="sha384-1q8mTJOASx8j1Au+a5WDVnPi2lkFfwwEAa8hDDdjZlpLegxhjVME1fgjWPGmkzs7" crossorigin="anonymous"> + <link rel="stylesheet" href="./../../../css/style.css"> + + <link rel="stylesheet" href="./../../../css/sphinx.css"> + + + <link rel="top" title="Apache Cassandra Documentation v3.7" href="../index.html"/> <link rel="next" title="Building and IDE Integration" href="ide.html"/> <link rel="prev" title="Troubleshooting" href="../troubleshooting/index.html"/> +</head> + + <body> + <!-- breadcrumbs --> +<div class="topnav"> + <div class="container breadcrumb-container"> + <ul class="breadcrumb"> + <li> + <div class="dropdown"> + <img class="asf-logo" src="./../../../img/asf_feather.png" /> + <a data-toggle="dropdown" href="#">Apache Software Foundation <span class="caret"></span></a> + <ul class="dropdown-menu" role="menu" aria-labelledby="dLabel"> + <li><a href="http://www.apache.org";>Apache Homepage</a></li> + <li><a href="http://www.apache.org/licenses/";>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><a href="./../../../">Apache Cassandra</a></li> + + + + + <li><a href="./../../../doc">Documentation</a></li> + + + + + + + <li>Cassandra Development</li> + + </ul> + </div> + + <!-- navbar --> + <nav class="navbar navbar-default navbar-static-top" role="navigation"> + <div class="container"> + <div class="navbar-header"> + <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#cassandra-menu" aria-expanded="false"> + <span class="sr-only">Toggle navigation</span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + </button> + <a class="navbar-brand" href="./../../../"><img src="./../../../img/cassandra_logo.png" alt="Apache Cassandra logo" /></a> + </div><!-- /.navbar-header --> + + <div id="cassandra-menu" class="collapse navbar-collapse"> + <ul class="nav navbar-nav navbar-right"> + <li><a href="./../../../">Home</a></li> + <li><a href="./../../../download/">Download</a></li> + <li><a href="./../../../doc/">Documentation</a></li> + <li><a href="./../../../community/">Community</a></li> + </ul> + </div><!-- /#cassandra-menu --> + + + </div> + </nav><!-- /.navbar --> +</div><!-- /.topnav --> + + <div class="container-fluid"> + <div class="row"> + <div class="col-md-2"> + <div class="doc-navigation"> + <div class="doc-menu" role="navigation"> + <div class="navbar-header"> + <button type="button" class="pull-left navbar-toggle" data-toggle="collapse" data-target=".sidebar-navbar-collapse"> + <span class="sr-only">Toggle navigation</span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + </button> + </div> + <div class="navbar-collapse collapse sidebar-navbar-collapse"> + <form id="doc-search-form" class="navbar-form" action="../search.html" method="get" role="search"> + <div class="form-group"> + <input type="text" size="30" class="form-control input-sm" name="q" placeholder="Search docs"> + <input type="hidden" name="check_keywords" value="yes" /> + <input type="hidden" name="area" value="default" /> + </div> + </form> + + + + <ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="../getting_started/index.html">Getting Started</a></li> +<li class="toctree-l1"><a class="reference internal" href="../architecture/index.html">Architecture</a></li> +<li class="toctree-l1"><a class="reference internal" href="../data_modeling/index.html">Data Modeling</a></li> +<li class="toctree-l1"><a class="reference internal" href="../cql/index.html">The Cassandra Query Language (CQL)</a></li> +<li class="toctree-l1"><a class="reference internal" href="../configuration/index.html">Configuring Cassandra</a></li> +<li class="toctree-l1"><a class="reference internal" href="../operating/index.html">Operating Cassandra</a></li> +<li class="toctree-l1"><a class="reference internal" href="../tools/index.html">Cassandra Tools</a></li> +<li class="toctree-l1"><a class="reference internal" href="../troubleshooting/index.html">Troubleshooting</a></li> +<li class="toctree-l1 current"><a class="current reference internal" href="#">Cassandra Development</a><ul> +<li class="toctree-l2"><a class="reference internal" href="ide.html">Building and IDE Integration</a></li> +<li class="toctree-l2"><a class="reference internal" href="testing.html">Testing</a></li> +<li class="toctree-l2"><a class="reference internal" href="patches.html">Contributing Code Changes</a></li> +<li class="toctree-l2"><a class="reference internal" href="code_style.html">Code Style</a></li> +<li class="toctree-l2"><a class="reference internal" href="how_to_review.html">Review Checklist</a></li> +<li class="toctree-l2"><a class="reference internal" href="how_to_commit.html">How-to Commit</a></li> +</ul> +</li> +<li class="toctree-l1"><a class="reference internal" href="../faq/index.html">Frequently Asked Questions</a></li> +<li class="toctree-l1"><a class="reference internal" href="../bugs.html">Reporting Bugs and Contributing</a></li> +<li class="toctree-l1"><a class="reference internal" href="../contactus.html">Contact us</a></li> +</ul> + + + + </div><!--/.nav-collapse --> + </div> + </div> + </div> + <div class="col-md-8"> + <div class="content doc-content"> + <div class="container"> + + <div class="section" id="cassandra-development"> +<h1>Cassandra Development<a class="headerlink" href="#cassandra-development" title="Permalink to this headline">¶</a></h1> +<div class="toctree-wrapper compound"> +<ul> +<li class="toctree-l1"><a class="reference internal" href="ide.html">Building and IDE Integration</a><ul> +<li class="toctree-l2"><a class="reference internal" href="ide.html#building-from-source">Building From Source</a></li> +<li class="toctree-l2"><a class="reference internal" href="ide.html#setting-up-cassandra-in-intellij-idea">Setting up Cassandra in IntelliJ IDEA</a></li> +<li class="toctree-l2"><a class="reference internal" href="ide.html#setting-up-cassandra-in-eclipse">Setting up Cassandra in Eclipse</a></li> +</ul> +</li> +<li class="toctree-l1"><a class="reference internal" href="testing.html">Testing</a><ul> +<li class="toctree-l2"><a class="reference internal" href="testing.html#unit-testing">Unit Testing</a></li> +<li class="toctree-l2"><a class="reference internal" href="testing.html#dtests">DTests</a></li> +<li class="toctree-l2"><a class="reference internal" href="testing.html#performance-testing">Performance Testing</a></li> +</ul> +</li> +<li class="toctree-l1"><a class="reference internal" href="patches.html">Contributing Code Changes</a><ul> +<li class="toctree-l2"><a class="reference internal" href="patches.html#choosing-what-to-work-on">Choosing What to Work on</a></li> +<li class="toctree-l2"><a class="reference internal" href="patches.html#before-you-start-coding">Before You Start Coding</a></li> +<li class="toctree-l2"><a class="reference internal" href="patches.html#creating-a-patch">Creating a Patch</a></li> +</ul> +</li> +<li class="toctree-l1"><a class="reference internal" href="code_style.html">Code Style</a><ul> +<li class="toctree-l2"><a class="reference internal" href="code_style.html#general-code-conventions">General Code Conventions</a></li> +<li class="toctree-l2"><a class="reference internal" href="code_style.html#exception-handling">Exception handling</a></li> +<li class="toctree-l2"><a class="reference internal" href="code_style.html#boilerplate">Boilerplate</a></li> +<li class="toctree-l2"><a class="reference internal" href="code_style.html#multiline-statements">Multiline statements</a></li> +<li class="toctree-l2"><a class="reference internal" href="code_style.html#whitespace">Whitespace</a></li> +<li class="toctree-l2"><a class="reference internal" href="code_style.html#imports">Imports</a></li> +<li class="toctree-l2"><a class="reference internal" href="code_style.html#format-files-for-ides">Format files for IDEs</a></li> +</ul> +</li> +<li class="toctree-l1"><a class="reference internal" href="how_to_review.html">Review Checklist</a></li> +<li class="toctree-l1"><a class="reference internal" href="how_to_commit.html">How-to Commit</a></li> +</ul> +</div> +</div> + + + + + <div class="doc-prev-next-links" role="navigation" aria-label="footer navigation"> + + <a href="ide.html" class="btn btn-default pull-right " role="button" title="Building and IDE Integration" accesskey="n">Next <span class="glyphicon glyphicon-circle-arrow-right" aria-hidden="true"></span></a> + + + <a href="../troubleshooting/index.html" class="btn btn-default" role="button" title="Troubleshooting" accesskey="p"><span class="glyphicon glyphicon-circle-arrow-left" aria-hidden="true"></span> Previous</a> + + </div> + + </div> + </div> + </div> + <div class="col-md-2"> + </div> + </div> +</div> + + <footer> + <div class="container"> + <div class="col-md-4 social-blk"> + <span class="social"> + <a href="https://twitter.com/cassandra"; + class="twitter-follow-button" + data-show-count="false" data-size="large">Follow @cassandra</a> + <script>!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0],p=/^http:/.test(d.location)?'http':'https';if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src=p+'://platform.twitter.com/widgets.js';fjs.parentNode.insertBefore(js,fjs);}}(document, 'script', 'twitter-wjs');</script> + <a href="https://twitter.com/intent/tweet?button_hashtag=cassandra"; + class="twitter-hashtag-button" + data-size="large" + data-related="ApacheCassandra">Tweet #cassandra</a> + <script>!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0],p=/^http:/.test(d.location)?'http':'https';if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src=p+'://platform.twitter.com/widgets.js';fjs.parentNode.insertBefore(js,fjs);}}(document, 'script', 'twitter-wjs');</script> + </span> + </div> + + <div class="col-md-8 trademark"> + <p>© 2016 <a href="http://apache.org";>The Apache Software Foundation</a>. + Apache, the Apache feather logo, and Apache Cassandra are trademarks of The Apache Software Foundation. + <p> + </div> + </div><!-- /.container --> +</footer> + +<!-- Javascript. Placed here so pages load faster --> +<script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.3/jquery.min.js";></script> +<script src="./../../../js/underscore-min.js"></script> +<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.6/js/bootstrap.min.js"; integrity="sha384-0mSbJDEHialfmuBBQP6A4Qrprq5OVfW37PRR3j5ELqxss1yVqOtnepnHVP9aJ7xS" crossorigin="anonymous"></script> + + +<script src="./../../../js/doctools.js"></script> +<script src="./../../../js/searchtools.js"></script> + + <script type="text/javascript"> var DOCUMENTATION_OPTIONS = { URL_ROOT: "", VERSION: "", COLLAPSE_INDEX: false, FILE_SUFFIX: ".html", HAS_SOURCE: false, SOURCELINK_SUFFIX: "" }; </script> + +<script type="text/javascript"> +$(function() { + // Stick the #nav to the top of the window + var nav = $('.doc-navigation'); + var navHomeY = nav.offset().top; + var isFixed = false; + var $w = $(window); + $w.scroll(function() { + var scrollTop = $w.scrollTop(); + var shouldBeFixed = $w.width() > 991 && scrollTop >= navHomeY - 10; + if (shouldBeFixed && !isFixed) { + nav.css({ + position: 'fixed', + top: 0, + left: nav.offset().left, + width: nav.width(), + }); + nav.addClass('fixed-navigation'); + isFixed = true; + } + else if (!shouldBeFixed && isFixed) + { + nav.css({ + position: 'static' + }); + nav.removeClass('fixed-navigation'); + isFixed = false; + } + }); +}); +</script> + + +<script type="text/javascript"> + var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl."; : "http://www.";); + document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E")); + + try { + var pageTracker = _gat._getTracker("UA-11583863-1"); + pageTracker._trackPageview(); + } catch(err) {} +</script> + + + </body> +</html>
Added: cassandra/site/publish/doc/3.7/development/patches.html URL: http://svn.apache.org/viewvc/cassandra/site/publish/doc/3.7/development/patches.html?rev=1758606&view=auto ============================================================================== --- cassandra/site/publish/doc/3.7/development/patches.html (added) +++ cassandra/site/publish/doc/3.7/development/patches.html Wed Aug 31 13:51:55 2016 @@ -0,0 +1,393 @@ +<!DOCTYPE html> +<html> + + + + +<head> + <meta charset="utf-8"> + <meta http-equiv="X-UA-Compatible" content="IE=edge"> + <meta name="viewport" content="width=device-width, initial-scale=1"> + <meta name="description" content="The Apache Cassandra database is the right choice when you need scalability and high availability without compromising performance. Linear scalability and proven fault-tolerance on commodity hardware or cloud infrastructure make it the perfect platform for mission-critical data. Cassandra's support for replicating across multiple datacenters is best-in-class, providing lower latency for your users and the peace of mind of knowing that you can survive regional outages. +"> + <meta name="keywords" content="cassandra, apache, apache cassandra, distributed storage, key value store, scalability, bigtable, dynamo" /> + <meta name="robots" content="index,follow" /> + <meta name="language" content="en" /> + + <title>Documentation</title> + + <link rel="canonical" href="http://cassandra.apache.org/doc/3.7/development/patches.html";> + + <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.6/css/bootstrap.min.css"; integrity="sha384-1q8mTJOASx8j1Au+a5WDVnPi2lkFfwwEAa8hDDdjZlpLegxhjVME1fgjWPGmkzs7" crossorigin="anonymous"> + <link rel="stylesheet" href="./../../../css/style.css"> + + <link rel="stylesheet" href="./../../../css/sphinx.css"> + + + <link rel="top" title="Apache Cassandra Documentation v3.7" href="../index.html"/> <link rel="up" title="Cassandra Development" href="index.html"/> <link rel="next" title="Code Style" href="code_style.html"/> <link rel="prev" title="Testing" href="testing.html"/> +</head> + + <body> + <!-- breadcrumbs --> +<div class="topnav"> + <div class="container breadcrumb-container"> + <ul class="breadcrumb"> + <li> + <div class="dropdown"> + <img class="asf-logo" src="./../../../img/asf_feather.png" /> + <a data-toggle="dropdown" href="#">Apache Software Foundation <span class="caret"></span></a> + <ul class="dropdown-menu" role="menu" aria-labelledby="dLabel"> + <li><a href="http://www.apache.org";>Apache Homepage</a></li> + <li><a href="http://www.apache.org/licenses/";>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><a href="./../../../">Apache Cassandra</a></li> + + + + + <li><a href="./../../../doc">Documentation</a></li> + + + + + <li><a href="./">Cassandra Development</a></li> + + + + <li>Contributing Code Changes</li> + + </ul> + </div> + + <!-- navbar --> + <nav class="navbar navbar-default navbar-static-top" role="navigation"> + <div class="container"> + <div class="navbar-header"> + <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#cassandra-menu" aria-expanded="false"> + <span class="sr-only">Toggle navigation</span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + </button> + <a class="navbar-brand" href="./../../../"><img src="./../../../img/cassandra_logo.png" alt="Apache Cassandra logo" /></a> + </div><!-- /.navbar-header --> + + <div id="cassandra-menu" class="collapse navbar-collapse"> + <ul class="nav navbar-nav navbar-right"> + <li><a href="./../../../">Home</a></li> + <li><a href="./../../../download/">Download</a></li> + <li><a href="./../../../doc/">Documentation</a></li> + <li><a href="./../../../community/">Community</a></li> + </ul> + </div><!-- /#cassandra-menu --> + + + </div> + </nav><!-- /.navbar --> +</div><!-- /.topnav --> + + <div class="container-fluid"> + <div class="row"> + <div class="col-md-2"> + <div class="doc-navigation"> + <div class="doc-menu" role="navigation"> + <div class="navbar-header"> + <button type="button" class="pull-left navbar-toggle" data-toggle="collapse" data-target=".sidebar-navbar-collapse"> + <span class="sr-only">Toggle navigation</span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + </button> + </div> + <div class="navbar-collapse collapse sidebar-navbar-collapse"> + <form id="doc-search-form" class="navbar-form" action="../search.html" method="get" role="search"> + <div class="form-group"> + <input type="text" size="30" class="form-control input-sm" name="q" placeholder="Search docs"> + <input type="hidden" name="check_keywords" value="yes" /> + <input type="hidden" name="area" value="default" /> + </div> + </form> + + + + <ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="../getting_started/index.html">Getting Started</a></li> +<li class="toctree-l1"><a class="reference internal" href="../architecture/index.html">Architecture</a></li> +<li class="toctree-l1"><a class="reference internal" href="../data_modeling/index.html">Data Modeling</a></li> +<li class="toctree-l1"><a class="reference internal" href="../cql/index.html">The Cassandra Query Language (CQL)</a></li> +<li class="toctree-l1"><a class="reference internal" href="../configuration/index.html">Configuring Cassandra</a></li> +<li class="toctree-l1"><a class="reference internal" href="../operating/index.html">Operating Cassandra</a></li> +<li class="toctree-l1"><a class="reference internal" href="../tools/index.html">Cassandra Tools</a></li> +<li class="toctree-l1"><a class="reference internal" href="../troubleshooting/index.html">Troubleshooting</a></li> +<li class="toctree-l1 current"><a class="reference internal" href="index.html">Cassandra Development</a><ul class="current"> +<li class="toctree-l2"><a class="reference internal" href="ide.html">Building and IDE Integration</a></li> +<li class="toctree-l2"><a class="reference internal" href="testing.html">Testing</a></li> +<li class="toctree-l2 current"><a class="current reference internal" href="#">Contributing Code Changes</a><ul> +<li class="toctree-l3"><a class="reference internal" href="#choosing-what-to-work-on">Choosing What to Work on</a></li> +<li class="toctree-l3"><a class="reference internal" href="#before-you-start-coding">Before You Start Coding</a></li> +<li class="toctree-l3"><a class="reference internal" href="#creating-a-patch">Creating a Patch</a></li> +</ul> +</li> +<li class="toctree-l2"><a class="reference internal" href="code_style.html">Code Style</a></li> +<li class="toctree-l2"><a class="reference internal" href="how_to_review.html">Review Checklist</a></li> +<li class="toctree-l2"><a class="reference internal" href="how_to_commit.html">How-to Commit</a></li> +</ul> +</li> +<li class="toctree-l1"><a class="reference internal" href="../faq/index.html">Frequently Asked Questions</a></li> +<li class="toctree-l1"><a class="reference internal" href="../bugs.html">Reporting Bugs and Contributing</a></li> +<li class="toctree-l1"><a class="reference internal" href="../contactus.html">Contact us</a></li> +</ul> + + + + </div><!--/.nav-collapse --> + </div> + </div> + </div> + <div class="col-md-8"> + <div class="content doc-content"> + <div class="container"> + + <div class="section" id="contributing-code-changes"> +<h1>Contributing Code Changes<a class="headerlink" href="#contributing-code-changes" title="Permalink to this headline">¶</a></h1> +<div class="section" id="choosing-what-to-work-on"> +<h2>Choosing What to Work on<a class="headerlink" href="#choosing-what-to-work-on" title="Permalink to this headline">¶</a></h2> +<p>Submitted patches can include bug fixes, changes to the Java code base, improvements for tooling (both Java or Python), documentation, testing or any other changes that requires changing the code base. Although the process of contributing code is always the same, the amount of work and time it takes to get a patch accepted also depends on the kind of issue you’re addressing.</p> +<dl class="docutils"> +<dt>As a general rule of thumb:</dt> +<dd><ul class="first last simple"> +<li>Major new features and significant changes to the code based will likely not going to be accepted without deeper discussion within the <a class="reference external" href="http://cassandra.apache.org/community/";>developer community</a></li> +<li>Bug fixes take higher priority compared to features</li> +<li>The extend to which tests are required depend on how likely your changes will effect the stability of Cassandra in production. Tooling changes requires fewer tests than storage engine changes.</li> +<li>Less complex patches will be faster to review: consider breaking up an issue into individual tasks and contributions that can be reviewed separately</li> +</ul> +</dd> +</dl> +<div class="admonition hint"> +<p class="first admonition-title">Hint</p> +<p class="last">Not sure what to work? Just pick an issue tagged with the <a class="reference external" href="https://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&jqlQuery=project+=+12310865+AND+labels+=+lhf+AND+status+!=+resolved";>low hanging fruit label</a> in JIRA, which we use to flag issues that could turn out to be good starter tasks for beginners.</p> +</div> +</div> +<div class="section" id="before-you-start-coding"> +<h2>Before You Start Coding<a class="headerlink" href="#before-you-start-coding" title="Permalink to this headline">¶</a></h2> +<p>Although contributions are highly appreciated, we do not guarantee that each contribution will become a part of Cassandra. Therefor it’s generally a good idea to first get some feedback on the things you plan to work on, especially about any new features or major changes to the code base. You can reach out to other developers on the mailing list or IRC channel listed on our <a class="reference external" href="http://cassandra.apache.org/community/";>community page</a>.</p> +<dl class="docutils"> +<dt>You should also</dt> +<dd><ul class="first last simple"> +<li>Avoid redundant work by searching for already reported issues in <a class="reference external" href="https://issues.apache.org/jira/browse/CASSANDRA";>JIRA</a></li> +<li>Create a new issue early in the process describing what you’re working on - not just after finishing your patch</li> +<li>Link related JIRA issues with your own ticket to provide a better context</li> +<li>Update your ticket from time to time by giving feedback on your progress and link a GitHub WIP branch with your current code</li> +<li>Ping people who you actively like to ask for advice on JIRA by <a class="reference external" href="https://confluence.atlassian.com/conf54/confluence-user-s-guide/sharing-content/using-mentions";>mentioning users</a></li> +</ul> +</dd> +<dt>There are also some fixed rules that you need to be aware:</dt> +<dd><ul class="first last simple"> +<li>Patches will only be applied to branches by following the release model</li> +<li>Code must be testable</li> +<li>Code must follow the <a class="reference internal" href="code_style.html"><span class="doc">Code Style</span></a> convention</li> +<li>Changes must not break compatibility between different Cassandra versions</li> +<li>Contributions must be covered by the Apache License</li> +</ul> +</dd> +</dl> +<div class="section" id="choosing-the-right-branches-to-work-on"> +<h3>Choosing the Right Branches to Work on<a class="headerlink" href="#choosing-the-right-branches-to-work-on" title="Permalink to this headline">¶</a></h3> +<p>There are currently multiple Cassandra versions maintained in individual branches:</p> +<table border="1" class="docutils"> +<colgroup> +<col width="23%" /> +<col width="77%" /> +</colgroup> +<thead valign="bottom"> +<tr class="row-odd"><th class="head">Version</th> +<th class="head">Policy</th> +</tr> +</thead> +<tbody valign="top"> +<tr class="row-even"><td>3.x</td> +<td>Tick-tock (see below)</td> +</tr> +<tr class="row-odd"><td>3.0</td> +<td>Bug fixes only</td> +</tr> +<tr class="row-even"><td>2.2</td> +<td>Bug fixes only</td> +</tr> +<tr class="row-odd"><td>2.1</td> +<td>Critical bug fixes only</td> +</tr> +</tbody> +</table> +<p>Corresponding branches in git are easy to recognize as they are named <code class="docutils literal"><span class="pre">cassandra-<release></span></code> (e.g. <code class="docutils literal"><span class="pre">cassandra-3.0</span></code>). The <code class="docutils literal"><span class="pre">trunk</span></code> branch is an exception, as it contains the most recent commits from all other branches and is used for creating new branches for future tick-tock releases.</p> +<div class="section" id="tick-tock-releases"> +<h4>Tick-Tock Releases<a class="headerlink" href="#tick-tock-releases" title="Permalink to this headline">¶</a></h4> +<p>New releases created as part of the <a class="reference external" href="http://www.planetcassandra.org/blog/cassandra-2-2-3-0-and-beyond/";>tick-tock release process</a> will either focus on stability (odd version numbers) or introduce new features (even version numbers). Any code for new Cassandra features you should be based on the latest, unreleased 3.x branch with even version number or based on trunk.</p> +</div> +<div class="section" id="bug-fixes"> +<h4>Bug Fixes<a class="headerlink" href="#bug-fixes" title="Permalink to this headline">¶</a></h4> +<p>Creating patches for bug fixes is a bit more complicated as this will depend on how many different versions of Cassandra are affected. In each case, the order for merging such changes will be <code class="docutils literal"><span class="pre">cassandra-2.1</span></code> -> <code class="docutils literal"><span class="pre">cassandra-2.2</span></code> -> <code class="docutils literal"><span class="pre">cassandra-3.0</span></code> -> <code class="docutils literal"><span class="pre">cassandra-3.x</span></code> -> <code class="docutils literal"><span class="pre">trunk</span></code>. But don’t worry, merging from 2.1 would be the worst case for bugs that affect all currently supported versions, which isn’t very common. As a contributor, you’re also not expected to provide a single patch for each version. What you need to do however is:</p> +<blockquote> +<div><ul class="simple"> +<li>Be clear about which versions you could verify to be affected by the bug</li> +<li>For 2.x: ask if a bug qualifies to be fixed in this release line, as this may be handled on case by case bases</li> +<li>If possible, create a patch against the lowest version in the branches listed above (e.g. if you found the bug in 3.9 you should try to fix it already in 3.0)</li> +<li>Test if the patch can be merged cleanly across branches in the direction listed above</li> +<li>Be clear which branches may need attention by the committer or even create custom patches for those if you can</li> +</ul> +</div></blockquote> +</div> +</div> +</div> +<div class="section" id="creating-a-patch"> +<h2>Creating a Patch<a class="headerlink" href="#creating-a-patch" title="Permalink to this headline">¶</a></h2> +<p>So you’ve finished coding and the great moment arrives: it’s time to submit your patch!</p> +<blockquote> +<div><ol class="arabic simple"> +<li>Create a branch for your changes if you haven’t done already. Many contributors name their branches based on ticket number and Cassandra version, e.g. <code class="docutils literal"><span class="pre">git</span> <span class="pre">checkout</span> <span class="pre">-b</span> <span class="pre">12345-3.0</span></code></li> +<li>Verify that you follow Cassandra’s <a class="reference internal" href="code_style.html"><span class="doc">Code Style</span></a></li> +<li>Make sure all tests (including yours) pass using ant as described in <a class="reference internal" href="testing.html"><span class="doc">Testing</span></a>. If you suspect a test failure is unrelated to your change, it may be useful to check the test’s status by searching the issue tracker or looking at <a class="reference external" href="https://cassci.datastax.com/";>CI</a> results for the relevant upstream version. Note that the full test suites take many hours to complete, so it is common to only run specific relevant tests locally before uploading a patch. Once a patch has been uploaded, the reviewer or committer can help setup CI jobs to run the full test suites.</li> +<li>Consider going through the <a class="reference internal" href="how_to_review.html"><span class="doc">Review Checklist</span></a> for your code. This will help you to understand how others will consider your change for inclusion.</li> +<li>Donât make the committer squash commits for you in the root branch either. Multiple commits are fine - and often preferable - during review stage, especially for incremental review, but once +1d, do either:</li> +</ol> +<blockquote> +<div><ol class="loweralpha simple"> +<li>Attach a patch to JIRA with a single squashed commit in it (per branch), or</li> +<li>Squash the commits in-place in your branches into one</li> +</ol> +</div></blockquote> +<ol class="arabic simple" start="6"> +<li>Include a CHANGES.txt entry (put it at the top of the list), and format the commit message appropriately in your patch ending with the following statement on the last line: <code class="docutils literal"><span class="pre">patch</span> <span class="pre">by</span> <span class="pre">X;</span> <span class="pre">reviewed</span> <span class="pre">by</span> <span class="pre">Y</span> <span class="pre">for</span> <span class="pre">CASSANDRA-ZZZZZ</span></code></li> +<li>When you’re happy with the result, create a patch:</li> +</ol> +<blockquote> +<div><div class="highlight-none"><div class="highlight"><pre><span></span>git add <any new or modified file> +git commit -m '<message>' +git format-patch HEAD~1 +mv <patch-file> <ticket-branchname.txt> (e.g. 12345-trunk.txt, 12345-3.0.txt) +</pre></div> +</div> +<p>Alternatively, many contributors prefer to make their branch available on GitHub. In this case, fork the Cassandra repository on GitHub and push your branch:</p> +<div class="highlight-none"><div class="highlight"><pre><span></span>git push --set-upstream origin 12345-3.0 +</pre></div> +</div> +</div></blockquote> +<ol class="arabic simple" start="8"> +<li>To make life easier for your reviewer/committer, you may want to make sure your patch applies cleanly to later branches and create additional patches/branches for later Cassandra versions to which your original patch does not apply cleanly. That said, this is not critical, and you will receive feedback on your patch regardless.</li> +<li>Attach the newly generated patch to the ticket/add a link to your branch and click “Submit Patch” at the top of the ticket. This will move the ticket into “Patch Available” status, indicating that your submission is ready for review.</li> +<li>Wait for other developers or committers to review it and hopefully +1 the ticket (see <a class="reference internal" href="how_to_review.html"><span class="doc">Review Checklist</span></a>). If your change does not receive a +1, do not be discouraged. If possible, the reviewer will give suggestions to improve your patch or explain why it is not suitable.</li> +<li>If the reviewer has given feedback to improve the patch, make the necessary changes and move the ticket into “Patch Available” once again.</li> +</ol> +</div></blockquote> +<p>Once the review process is complete, you will receive a +1. Wait for a committer to commit it. Do not delete your branches immediately after theyâve been committed - keep them on GitHub for a while. Alternatively, attach a patch to JIRA for historical record. Itâs not that uncommon for a committer to mess up a merge. In case of that happening, access to the original code is required, or else youâll have to redo some of the work.</p> +</div> +</div> + + + + + <div class="doc-prev-next-links" role="navigation" aria-label="footer navigation"> + + <a href="code_style.html" class="btn btn-default pull-right " role="button" title="Code Style" accesskey="n">Next <span class="glyphicon glyphicon-circle-arrow-right" aria-hidden="true"></span></a> + + + <a href="testing.html" class="btn btn-default" role="button" title="Testing" accesskey="p"><span class="glyphicon glyphicon-circle-arrow-left" aria-hidden="true"></span> Previous</a> + + </div> + + </div> + </div> + </div> + <div class="col-md-2"> + </div> + </div> +</div> + + <footer> + <div class="container"> + <div class="col-md-4 social-blk"> + <span class="social"> + <a href="https://twitter.com/cassandra"; + class="twitter-follow-button" + data-show-count="false" data-size="large">Follow @cassandra</a> + <script>!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0],p=/^http:/.test(d.location)?'http':'https';if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src=p+'://platform.twitter.com/widgets.js';fjs.parentNode.insertBefore(js,fjs);}}(document, 'script', 'twitter-wjs');</script> + <a href="https://twitter.com/intent/tweet?button_hashtag=cassandra"; + class="twitter-hashtag-button" + data-size="large" + data-related="ApacheCassandra">Tweet #cassandra</a> + <script>!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0],p=/^http:/.test(d.location)?'http':'https';if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src=p+'://platform.twitter.com/widgets.js';fjs.parentNode.insertBefore(js,fjs);}}(document, 'script', 'twitter-wjs');</script> + </span> + </div> + + <div class="col-md-8 trademark"> + <p>© 2016 <a href="http://apache.org";>The Apache Software Foundation</a>. + Apache, the Apache feather logo, and Apache Cassandra are trademarks of The Apache Software Foundation. + <p> + </div> + </div><!-- /.container --> +</footer> + +<!-- Javascript. Placed here so pages load faster --> +<script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.3/jquery.min.js";></script> +<script src="./../../../js/underscore-min.js"></script> +<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.6/js/bootstrap.min.js"; integrity="sha384-0mSbJDEHialfmuBBQP6A4Qrprq5OVfW37PRR3j5ELqxss1yVqOtnepnHVP9aJ7xS" crossorigin="anonymous"></script> + + +<script src="./../../../js/doctools.js"></script> +<script src="./../../../js/searchtools.js"></script> + + <script type="text/javascript"> var DOCUMENTATION_OPTIONS = { URL_ROOT: "", VERSION: "", COLLAPSE_INDEX: false, FILE_SUFFIX: ".html", HAS_SOURCE: false, SOURCELINK_SUFFIX: "" }; </script> + +<script type="text/javascript"> +$(function() { + // Stick the #nav to the top of the window + var nav = $('.doc-navigation'); + var navHomeY = nav.offset().top; + var isFixed = false; + var $w = $(window); + $w.scroll(function() { + var scrollTop = $w.scrollTop(); + var shouldBeFixed = $w.width() > 991 && scrollTop >= navHomeY - 10; + if (shouldBeFixed && !isFixed) { + nav.css({ + position: 'fixed', + top: 0, + left: nav.offset().left, + width: nav.width(), + }); + nav.addClass('fixed-navigation'); + isFixed = true; + } + else if (!shouldBeFixed && isFixed) + { + nav.css({ + position: 'static' + }); + nav.removeClass('fixed-navigation'); + isFixed = false; + } + }); +}); +</script> + + +<script type="text/javascript"> + var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl."; : "http://www.";); + document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E")); + + try { + var pageTracker = _gat._getTracker("UA-11583863-1"); + pageTracker._trackPageview(); + } catch(err) {} +</script> + + + </body> +</html> Added: cassandra/site/publish/doc/3.7/development/testing.html URL: http://svn.apache.org/viewvc/cassandra/site/publish/doc/3.7/development/testing.html?rev=1758606&view=auto ============================================================================== --- cassandra/site/publish/doc/3.7/development/testing.html (added) +++ cassandra/site/publish/doc/3.7/development/testing.html Wed Aug 31 13:51:55 2016 @@ -0,0 +1,313 @@ +<!DOCTYPE html> +<html> + + + + +<head> + <meta charset="utf-8"> + <meta http-equiv="X-UA-Compatible" content="IE=edge"> + <meta name="viewport" content="width=device-width, initial-scale=1"> + <meta name="description" content="The Apache Cassandra database is the right choice when you need scalability and high availability without compromising performance. Linear scalability and proven fault-tolerance on commodity hardware or cloud infrastructure make it the perfect platform for mission-critical data. Cassandra's support for replicating across multiple datacenters is best-in-class, providing lower latency for your users and the peace of mind of knowing that you can survive regional outages. +"> + <meta name="keywords" content="cassandra, apache, apache cassandra, distributed storage, key value store, scalability, bigtable, dynamo" /> + <meta name="robots" content="index,follow" /> + <meta name="language" content="en" /> + + <title>Documentation</title> + + <link rel="canonical" href="http://cassandra.apache.org/doc/3.7/development/testing.html";> + + <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.6/css/bootstrap.min.css"; integrity="sha384-1q8mTJOASx8j1Au+a5WDVnPi2lkFfwwEAa8hDDdjZlpLegxhjVME1fgjWPGmkzs7" crossorigin="anonymous"> + <link rel="stylesheet" href="./../../../css/style.css"> + + <link rel="stylesheet" href="./../../../css/sphinx.css"> + + + <link rel="top" title="Apache Cassandra Documentation v3.7" href="../index.html"/> <link rel="up" title="Cassandra Development" href="index.html"/> <link rel="next" title="Contributing Code Changes" href="patches.html"/> <link rel="prev" title="Building and IDE Integration" href="ide.html"/> +</head> + + <body> + <!-- breadcrumbs --> +<div class="topnav"> + <div class="container breadcrumb-container"> + <ul class="breadcrumb"> + <li> + <div class="dropdown"> + <img class="asf-logo" src="./../../../img/asf_feather.png" /> + <a data-toggle="dropdown" href="#">Apache Software Foundation <span class="caret"></span></a> + <ul class="dropdown-menu" role="menu" aria-labelledby="dLabel"> + <li><a href="http://www.apache.org";>Apache Homepage</a></li> + <li><a href="http://www.apache.org/licenses/";>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><a href="./../../../">Apache Cassandra</a></li> + + + + + <li><a href="./../../../doc">Documentation</a></li> + + + + + <li><a href="./">Cassandra Development</a></li> + + + + <li>Testing</li> + + </ul> + </div> + + <!-- navbar --> + <nav class="navbar navbar-default navbar-static-top" role="navigation"> + <div class="container"> + <div class="navbar-header"> + <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#cassandra-menu" aria-expanded="false"> + <span class="sr-only">Toggle navigation</span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + </button> + <a class="navbar-brand" href="./../../../"><img src="./../../../img/cassandra_logo.png" alt="Apache Cassandra logo" /></a> + </div><!-- /.navbar-header --> + + <div id="cassandra-menu" class="collapse navbar-collapse"> + <ul class="nav navbar-nav navbar-right"> + <li><a href="./../../../">Home</a></li> + <li><a href="./../../../download/">Download</a></li> + <li><a href="./../../../doc/">Documentation</a></li> + <li><a href="./../../../community/">Community</a></li> + </ul> + </div><!-- /#cassandra-menu --> + + + </div> + </nav><!-- /.navbar --> +</div><!-- /.topnav --> + + <div class="container-fluid"> + <div class="row"> + <div class="col-md-2"> + <div class="doc-navigation"> + <div class="doc-menu" role="navigation"> + <div class="navbar-header"> + <button type="button" class="pull-left navbar-toggle" data-toggle="collapse" data-target=".sidebar-navbar-collapse"> + <span class="sr-only">Toggle navigation</span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + </button> + </div> + <div class="navbar-collapse collapse sidebar-navbar-collapse"> + <form id="doc-search-form" class="navbar-form" action="../search.html" method="get" role="search"> + <div class="form-group"> + <input type="text" size="30" class="form-control input-sm" name="q" placeholder="Search docs"> + <input type="hidden" name="check_keywords" value="yes" /> + <input type="hidden" name="area" value="default" /> + </div> + </form> + + + + <ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="../getting_started/index.html">Getting Started</a></li> +<li class="toctree-l1"><a class="reference internal" href="../architecture/index.html">Architecture</a></li> +<li class="toctree-l1"><a class="reference internal" href="../data_modeling/index.html">Data Modeling</a></li> +<li class="toctree-l1"><a class="reference internal" href="../cql/index.html">The Cassandra Query Language (CQL)</a></li> +<li class="toctree-l1"><a class="reference internal" href="../configuration/index.html">Configuring Cassandra</a></li> +<li class="toctree-l1"><a class="reference internal" href="../operating/index.html">Operating Cassandra</a></li> +<li class="toctree-l1"><a class="reference internal" href="../tools/index.html">Cassandra Tools</a></li> +<li class="toctree-l1"><a class="reference internal" href="../troubleshooting/index.html">Troubleshooting</a></li> +<li class="toctree-l1 current"><a class="reference internal" href="index.html">Cassandra Development</a><ul class="current"> +<li class="toctree-l2"><a class="reference internal" href="ide.html">Building and IDE Integration</a></li> +<li class="toctree-l2 current"><a class="current reference internal" href="#">Testing</a><ul> +<li class="toctree-l3"><a class="reference internal" href="#unit-testing">Unit Testing</a></li> +<li class="toctree-l3"><a class="reference internal" href="#dtests">DTests</a></li> +<li class="toctree-l3"><a class="reference internal" href="#performance-testing">Performance Testing</a></li> +</ul> +</li> +<li class="toctree-l2"><a class="reference internal" href="patches.html">Contributing Code Changes</a></li> +<li class="toctree-l2"><a class="reference internal" href="code_style.html">Code Style</a></li> +<li class="toctree-l2"><a class="reference internal" href="how_to_review.html">Review Checklist</a></li> +<li class="toctree-l2"><a class="reference internal" href="how_to_commit.html">How-to Commit</a></li> +</ul> +</li> +<li class="toctree-l1"><a class="reference internal" href="../faq/index.html">Frequently Asked Questions</a></li> +<li class="toctree-l1"><a class="reference internal" href="../bugs.html">Reporting Bugs and Contributing</a></li> +<li class="toctree-l1"><a class="reference internal" href="../contactus.html">Contact us</a></li> +</ul> + + + + </div><!--/.nav-collapse --> + </div> + </div> + </div> + <div class="col-md-8"> + <div class="content doc-content"> + <div class="container"> + + <div class="section" id="testing"> +<h1>Testing<a class="headerlink" href="#testing" title="Permalink to this headline">¶</a></h1> +<p>Creating tests is one of the most important and also most difficult parts of developing Cassandra. There are different ways to test your code depending on what you’re working on.</p> +<div class="section" id="unit-testing"> +<h2>Unit Testing<a class="headerlink" href="#unit-testing" title="Permalink to this headline">¶</a></h2> +<p>The most simple way to test code in Cassandra is probably by writing a unit test. Cassandra uses JUnit as a testing framework and test cases can be found in the <code class="docutils literal"><span class="pre">test/unit</span></code> directory. Ideally youâd be able to create a unit test for your implementation that would exclusively cover the class you created (the unit under test). Unfortunately this is not always possible and Cassandra doesnât have a very mock friendly code base. Often youâll find yourself in a situation where you have to make use of an embedded Cassandra instance that youâll be able to interact with in your test. If you want to make use of CQL in your test, you can simply extend CQLTester and use some of the convenient helper methods such as in the following example.</p> +<div class="highlight-java"><div class="highlight"><pre><span></span><span class="nd">@Test</span> +<span class="kd">public</span> <span class="kt">void</span> <span class="nf">testBatchAndList</span><span class="o">()</span> <span class="kd">throws</span> <span class="n">Throwable</span> +<span class="o">{</span> + <span class="n">createTable</span><span class="o">(</span><span class="s">"CREATE TABLE %s (k int PRIMARY KEY, l list<int>)"</span><span class="o">);</span> + <span class="n">execute</span><span class="o">(</span><span class="s">"BEGIN BATCH "</span> <span class="o">+</span> + <span class="s">"UPDATE %1$s SET l = l +[ 1 ] WHERE k = 0; "</span> <span class="o">+</span> + <span class="s">"UPDATE %1$s SET l = l + [ 2 ] WHERE k = 0; "</span> <span class="o">+</span> + <span class="s">"UPDATE %1$s SET l = l + [ 3 ] WHERE k = 0; "</span> <span class="o">+</span> + <span class="s">"APPLY BATCH"</span><span class="o">);</span> + + <span class="n">assertRows</span><span class="o">(</span><span class="n">execute</span><span class="o">(</span><span class="s">"SELECT l FROM %s WHERE k = 0"</span><span class="o">),</span> + <span class="n">row</span><span class="o">(</span><span class="n">list</span><span class="o">(</span><span class="mi">1</span><span class="o">,</span> <span class="mi">2</span><span class="o">,</span> <span class="mi">3</span><span class="o">)));</span> +<span class="o">}</span> +</pre></div> +</div> +<p>Unit tests can be run from the command line using the <code class="docutils literal"><span class="pre">ant</span> <span class="pre">test</span></code> command, <code class="docutils literal"><span class="pre">ant</span> <span class="pre">test</span> <span class="pre">-Dtest.name=<simple_classname></span></code> to execute a test suite or <code class="docutils literal"><span class="pre">ant</span> <span class="pre">testsome</span> <span class="pre">-Dtest.name=<FQCN></span> <span class="pre">-Dtest.methods=<testmethod1>[,testmethod2]</span></code> for individual tests. For example, to run all test methods in the <code class="docutils literal"><span class="pre">org.apache.cassandra.cql3.SimpleQueryTest</span></code> class, you would run:</p> +<div class="highlight-none"><div class="highlight"><pre><span></span>ant test -Dtest.name=SimpleQueryTest +</pre></div> +</div> +<p>To run only the <code class="docutils literal"><span class="pre">testStaticCompactTables()</span></code> test method from that class, you would run:</p> +<div class="highlight-none"><div class="highlight"><pre><span></span>ant testsome -Dtest.name=org.apache.cassandra.cql3.SimpleQueryTest -Dtest.methods=testStaticCompactTables +</pre></div> +</div> +<div class="section" id="long-running-tests"> +<h3>Long running tests<a class="headerlink" href="#long-running-tests" title="Permalink to this headline">¶</a></h3> +<p>Test that consume a significant amount of time during execution can be found in the <code class="docutils literal"><span class="pre">test/long</span></code> directory and executed as a regular JUnit test or standalone program. Except for the execution time, thereâs nothing really special about them. However, ant will execute tests under <code class="docutils literal"><span class="pre">test/long</span></code> only when using the <code class="docutils literal"><span class="pre">ant</span> <span class="pre">long-test</span></code> target.</p> +</div> +</div> +<div class="section" id="dtests"> +<h2>DTests<a class="headerlink" href="#dtests" title="Permalink to this headline">¶</a></h2> +<p>One way of doing integration or system testing at larger scale is by using <a class="reference external" href="https://github.com/riptano/cassandra-dtest";>dtest</a>, which stands for âCassandra Distributed Testsâ. The idea is to automatically setup Cassandra clusters using various configurations and simulate certain use cases you want to test. This is done using Python scripts and <code class="docutils literal"><span class="pre">ccmlib</span></code> from the <a class="reference external" href="https://github.com/pcmanus/ccm";>ccm</a> project. Dtests will setup clusters using this library just as you do running ad-hoc <code class="docutils literal"><span class="pre">ccm</span></code> commands on your local machine. Afterwards dtests will use the <a class="reference external" href="http://datastax.github.io/python-driver/installation.html";>Python driver</a> to interact with the nodes, manipulate the file system, analyze logs or mess with individual nodes.</p> +<p>Using dtests helps us to prevent regression bugs by continually executing tests on the <a class="reference external" href="http://cassci.datastax.com/";>CI server</a> against new patches. For frequent contributors, this Jenkins is set up to build branches from their GitHub repositories. It is likely that your reviewer will use this Jenkins instance to run tests for your patch. Read more on the motivation behind the CI server <a class="reference external" href="http://www.datastax.com/dev/blog/cassandra-testing-improvements-for-developer-convenience-and-confidence";>here</a>.</p> +<p>The best way to learn how to write dtests is probably by reading the introduction “<a class="reference external" href="http://www.datastax.com/dev/blog/how-to-write-a-dtest";>How to Write a Dtest</a>” and by looking at existing, recently updated tests in the project. New tests must follow certain <a class="reference external" href="https://github.com/riptano/cassandra-dtest/blob/master/CONTRIBUTING.md";>style conventions</a> that are being checked before accepting contributions. In contrast to Cassandra, dtest issues and pull-requests are managed on github, therefor you should make sure to link any created dtests in your Cassandra ticket and also refer to the ticket number in your dtest PR.</p> +<p>Creating a good dtest can be tough, but it should not prevent you from submitting patches! Please ask in the corresponding JIRA ticket how to write a good dtest for the patch. In most cases a reviewer or committer will able to support you, and in some cases they may offer to write a dtest for you.</p> +</div> +<div class="section" id="performance-testing"> +<h2>Performance Testing<a class="headerlink" href="#performance-testing" title="Permalink to this headline">¶</a></h2> +<p>Performance tests for Cassandra are a special breed of tests that are not part of the usual patch contribution process. In fact you can contribute tons of patches to Cassandra without ever running performance tests. They are important however when working on performance improvements, as such improvements must be measurable.</p> +<div class="section" id="cassandra-stress-tool"> +<h3>Cassandra Stress Tool<a class="headerlink" href="#cassandra-stress-tool" title="Permalink to this headline">¶</a></h3> +<p>TODO: <a class="reference external" href="https://issues.apache.org/jira/browse/CASSANDRA-12365";>CASSANDRA-12365</a></p> +</div> +<div class="section" id="cstar-perf"> +<h3>cstar_perf<a class="headerlink" href="#cstar-perf" title="Permalink to this headline">¶</a></h3> +<p>Another tool available on github is <a class="reference external" href="https://github.com/datastax/cstar_perf";>cstar_perf</a> that can be used for intensive performance testing in large clusters or locally. Please refer to the project page on how to set it up and how to use it.</p> +</div> +</div> +</div> + + + + + <div class="doc-prev-next-links" role="navigation" aria-label="footer navigation"> + + <a href="patches.html" class="btn btn-default pull-right " role="button" title="Contributing Code Changes" accesskey="n">Next <span class="glyphicon glyphicon-circle-arrow-right" aria-hidden="true"></span></a> + + + <a href="ide.html" class="btn btn-default" role="button" title="Building and IDE Integration" accesskey="p"><span class="glyphicon glyphicon-circle-arrow-left" aria-hidden="true"></span> Previous</a> + + </div> + + </div> + </div> + </div> + <div class="col-md-2"> + </div> + </div> +</div> + + <footer> + <div class="container"> + <div class="col-md-4 social-blk"> + <span class="social"> + <a href="https://twitter.com/cassandra"; + class="twitter-follow-button" + data-show-count="false" data-size="large">Follow @cassandra</a> + <script>!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0],p=/^http:/.test(d.location)?'http':'https';if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src=p+'://platform.twitter.com/widgets.js';fjs.parentNode.insertBefore(js,fjs);}}(document, 'script', 'twitter-wjs');</script> + <a href="https://twitter.com/intent/tweet?button_hashtag=cassandra"; + class="twitter-hashtag-button" + data-size="large" + data-related="ApacheCassandra">Tweet #cassandra</a> + <script>!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0],p=/^http:/.test(d.location)?'http':'https';if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src=p+'://platform.twitter.com/widgets.js';fjs.parentNode.insertBefore(js,fjs);}}(document, 'script', 'twitter-wjs');</script> + </span> + </div> + + <div class="col-md-8 trademark"> + <p>© 2016 <a href="http://apache.org";>The Apache Software Foundation</a>. + Apache, the Apache feather logo, and Apache Cassandra are trademarks of The Apache Software Foundation. + <p> + </div> + </div><!-- /.container --> +</footer> + +<!-- Javascript. Placed here so pages load faster --> +<script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.3/jquery.min.js";></script> +<script src="./../../../js/underscore-min.js"></script> +<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.6/js/bootstrap.min.js"; integrity="sha384-0mSbJDEHialfmuBBQP6A4Qrprq5OVfW37PRR3j5ELqxss1yVqOtnepnHVP9aJ7xS" crossorigin="anonymous"></script> + + +<script src="./../../../js/doctools.js"></script> +<script src="./../../../js/searchtools.js"></script> + + <script type="text/javascript"> var DOCUMENTATION_OPTIONS = { URL_ROOT: "", VERSION: "", COLLAPSE_INDEX: false, FILE_SUFFIX: ".html", HAS_SOURCE: false, SOURCELINK_SUFFIX: "" }; </script> + +<script type="text/javascript"> +$(function() { + // Stick the #nav to the top of the window + var nav = $('.doc-navigation'); + var navHomeY = nav.offset().top; + var isFixed = false; + var $w = $(window); + $w.scroll(function() { + var scrollTop = $w.scrollTop(); + var shouldBeFixed = $w.width() > 991 && scrollTop >= navHomeY - 10; + if (shouldBeFixed && !isFixed) { + nav.css({ + position: 'fixed', + top: 0, + left: nav.offset().left, + width: nav.width(), + }); + nav.addClass('fixed-navigation'); + isFixed = true; + } + else if (!shouldBeFixed && isFixed) + { + nav.css({ + position: 'static' + }); + nav.removeClass('fixed-navigation'); + isFixed = false; + } + }); +}); +</script> + + +<script type="text/javascript"> + var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl."; : "http://www.";); + document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E")); + + try { + var pageTracker = _gat._getTracker("UA-11583863-1"); + pageTracker._trackPageview(); + } catch(err) {} +</script> + + + </body> +</html> Added: cassandra/site/publish/doc/latest/_images/eclipse_debug0.png URL: http://svn.apache.org/viewvc/cassandra/site/publish/doc/latest/_images/eclipse_debug0.png?rev=1758606&view=auto ============================================================================== Binary file - no diff available. Propchange: cassandra/site/publish/doc/latest/_images/eclipse_debug0.png ------------------------------------------------------------------------------ svn:mime-type = image/png Added: cassandra/site/publish/doc/latest/_images/eclipse_debug1.png URL: http://svn.apache.org/viewvc/cassandra/site/publish/doc/latest/_images/eclipse_debug1.png?rev=1758606&view=auto ============================================================================== Binary file - no diff available. Propchange: cassandra/site/publish/doc/latest/_images/eclipse_debug1.png ------------------------------------------------------------------------------ svn:mime-type = image/png Added: cassandra/site/publish/doc/latest/_images/eclipse_debug2.png URL: http://svn.apache.org/viewvc/cassandra/site/publish/doc/latest/_images/eclipse_debug2.png?rev=1758606&view=auto ============================================================================== Binary file - no diff available. Propchange: cassandra/site/publish/doc/latest/_images/eclipse_debug2.png ------------------------------------------------------------------------------ svn:mime-type = image/png Added: cassandra/site/publish/doc/latest/_images/eclipse_debug3.png URL: http://svn.apache.org/viewvc/cassandra/site/publish/doc/latest/_images/eclipse_debug3.png?rev=1758606&view=auto ============================================================================== Binary file - no diff available. Propchange: cassandra/site/publish/doc/latest/_images/eclipse_debug3.png ------------------------------------------------------------------------------ svn:mime-type = image/png Added: cassandra/site/publish/doc/latest/_images/eclipse_debug4.png URL: http://svn.apache.org/viewvc/cassandra/site/publish/doc/latest/_images/eclipse_debug4.png?rev=1758606&view=auto ============================================================================== Binary file - no diff available. Propchange: cassandra/site/publish/doc/latest/_images/eclipse_debug4.png ------------------------------------------------------------------------------ svn:mime-type = image/png Added: cassandra/site/publish/doc/latest/_images/eclipse_debug5.png URL: http://svn.apache.org/viewvc/cassandra/site/publish/doc/latest/_images/eclipse_debug5.png?rev=1758606&view=auto ============================================================================== Binary file - no diff available. Propchange: cassandra/site/publish/doc/latest/_images/eclipse_debug5.png ------------------------------------------------------------------------------ svn:mime-type = image/png Added: cassandra/site/publish/doc/latest/_images/eclipse_debug6.png URL: http://svn.apache.org/viewvc/cassandra/site/publish/doc/latest/_images/eclipse_debug6.png?rev=1758606&view=auto ============================================================================== Binary file - no diff available. Propchange: cassandra/site/publish/doc/latest/_images/eclipse_debug6.png ------------------------------------------------------------------------------ svn:mime-type = image/png
