[ganeti/ganeti_webmgr] b17fc24 Point dev guide to release, test_cluster docs

[g...@osuosl.org]

The branch, enhancement/13785 has been updated

Old revision: 67ce1e50a6f938c1611cbc66fb74d73d24b14e12, new revision: b17fc2415653329cde55fd15367e9e3d78b46791.
via b17fc2415653329cde55fd15367e9e3d78b46791 (commit)
from 67ce1e50a6f938c1611cbc66fb74d73d24b14e12 (commit)

- Log -----------------------------------------------------------------
commit b17fc2415653329cde55fd15367e9e3d78b46791
Author: Ken Lett <ken...@osuosl.org>
Date: Tue Mar 25 16:41:38 2014 -0700

Point dev guide to release, test_cluster docs

Add erroneously removed test_cluster doc

Add missing refs and arrange correctly

Change name to Developer Installation

Copy general testing info into tests doc

Delete contributors, now included from AUTHORS

refs #13785


Summary of changes:
docs/source/dev/contributors.rst | 45 -------------------
docs/source/dev/developers.rst | 39 +++-------------
docs/source/dev/installation.rst | 6 ++-
docs/source/dev/test_cluster.rst | 2 +-
docs/source/dev/tests.rst | 46 ++++++++++++++++++++
docs/source/index.rst | 42 +++++++++++-------
.../release.rst => project_info/release_cycle.rst} | 2 +-
7 files changed, 85 insertions(+), 97 deletions(-)
delete mode 100644 docs/source/dev/contributors.rst
rename docs/source/{dev/release.rst => project_info/release_cycle.rst} (98%)

diff --git a/docs/source/dev/contributors.rst b/docs/source/dev/contributors.rst
deleted file mode 100644
index 55c7b9c..0000000
--- a/docs/source/dev/contributors.rst
+++ /dev/null
@@ -1,45 +0,0 @@
-Current Contributors
-====================
-
-Below is a list of contributions made to the Ganeti Web Manager project.
-
-Main Contributors
------------------
-
-- **Peter Krenesky** (*kreneskyp*)
- Sep. 2010 - Present
-- **Corbin Simpson** (*MostAwesomeDude*)
- Oct. 2010 - Present
-- **Trevor Bramwell** (*bramwelt*)
- Sep. 2010 - Present
-- **Scott White** (*whiteau*)
- Oct. 2010 - Mar. 2011
-- **Emily Dunham** (*edunham*)
- Apr. 2011 - Present
-
-Google Code In Contributors, 2010
----------------------------------
-
-- **Jonathan Smith** (jaydez) -
- `j.ja...@gmail.com <mailto:j.ja...@gmail.com>`_
-- **Kyle Cesare** (kylc) -
- `kce...@gmail.com <mailto:kce...@gmail.com>`_
-- **Kapeel Sable** (kapeel) -
- `kapeel...@gmail.com <mailto:kapeel...@gmail.com>`_
-- **Samuel Dolean** (samm) -
- `selo...@gmail.com <mailto:selo...@gmail.com>`_
-- **David Zderic** - `dzd...@gmail.com <mailto:dzd...@gmail.com>`_
-- **Crypt Wizard** -
- `crypt...@gmail.com <mailto:crypt...@gmail.com>`_
-- **Piotr Banaszkiewicz** (pbnan) -
- `pi...@banaszkiewicz.org <mailto:pi...@banaszkiewicz.org>`_
-
-Other Contributors
-------------------
-
-- **Apollon** (apoikos) -
- `apo...@noc.grnet.gr <mailto:apo...@noc.grnet.gr>`_
-- **Faidon Liambotis** (paravoid) -
- `fai...@admin.grnet.gr <mailto:fai...@admin.grnet.gr>`_
-- **Leonidas Poulopoulos** -
- `leo...@noc.grnet.gr <mailto:leo...@noc.grnet.gr>`_

diff --git a/docs/source/dev/developers.rst b/docs/source/dev/developers.rst
index 5f28ca2..847f4cb 100644
--- a/docs/source/dev/developers.rst
+++ b/docs/source/dev/developers.rst
@@ -6,7 +6,7 @@ Developer Guide

This guide is intended to help you begin writing code and documentation for the |gwm| project. Please read the :ref:`OSL Development Process <process>` for information on how this project is managed and what we do to review and integrate code into the master repository. Please read the entire guide before beginning work, we will not be able to accept contributions that don't follow these guidelines and standards.

-For information on our release cycle and versions, please see :ref:`release`.
+For information on our release cycle and versions, please see :ref:`release_cycle` .


Issue Tracking
@@ -41,6 +41,10 @@ From Github, you can `clone or fork from our repository mirror`_.

.. _`clone or fork from our repository mirror`: https://github.com/osuosl/ganeti_webmgr

+Install
+-------
+
+To install the GWM application for development work, please see :ref:`developer_installation`

Repository Layout
-----------------
@@ -147,37 +151,10 @@ Development VM
.. todo::
insert information on how and why you might use this

-Ganeti Test Cluster
-~~~~~~~~~~~~~~~~~~~
-
-To test new code in |gwm| it is often necessary to have a Ganeti cluster to manage. Using Vagrant, a virtual multi-node cluster can easily be created:
-
-- clone https://github.com/ramereth/vagrant-ganeti.git
-- add the following to your hosts file :
-
-::
-
- 33.33.33.10 ganeti.example.org
- 33.33.33.11 node1.example.org
- 33.33.33.12 node2.example.org
- 33.33.33.13 node3.example.org
-
-- enter the vagrant-ganeti directory and type
-
- ::
-
- vagrant up node1
-
-Vagrant will download, spin up, and provision a virtual machine with Ganeti installed and ready to use. You can now add the ganeti.example.org cluster from the |gwm| and create virtual machine instances on it. To spin up additional nodes, simply:
-
-::
-
- vagrant up node2
- vagrant up node3
-
-See the `vagrant-ganeti page`_ for more details.
+Test Cluster
+~~~~~~~~~~~~

-.. _`vagrant-ganeti page`: https://github.com/ramereth/vagrant-ganeti
+For instructions on setting up and using a vagrant cluster to test your code, see :ref:`test_cluster`

Adding features
---------------

diff --git a/docs/source/dev/installation.rst b/docs/source/dev/installation.rst
index 86179c6..b8ce17c 100644
--- a/docs/source/dev/installation.rst
+++ b/docs/source/dev/installation.rst
@@ -1,7 +1,9 @@
+:orphan:
+
.. _developer_installation:

-Installation
-============
+Developer Installation
+======================

In order to install |gwm| for end users, one must download ``wheel`` packages.
This, however, is not a case for developers.

diff --git a/docs/source/dev/test_cluster.rst b/docs/source/dev/test_cluster.rst
index d95794a..15dced5 100644
--- a/docs/source/dev/test_cluster.rst
+++ b/docs/source/dev/test_cluster.rst
@@ -1,4 +1,4 @@
-.. test_cluster:
+.. _test_cluster:

Vagrant Test Cluster
====================

diff --git a/docs/source/dev/tests.rst b/docs/source/dev/tests.rst
index 2b3a3f7..40970e8 100644
--- a/docs/source/dev/tests.rst
+++ b/docs/source/dev/tests.rst
@@ -3,6 +3,52 @@
Writing Tests
=============

+The following are general guidelines. For specific details on how to write |gwm| tests, please see See :ref:`testing`.
+
+Ganeti Web Manager has a fairly complete test suite. New code should have matching tests. Before committing code, run the suite for Ganeti Web Manager and `Object Permissions <http://code. osuosl.org/projects/object-permissions>`_
+
+::
+
+ ./manage.py test ganeti_web
+ ./manage.py test object_permissions
+
+
+Clean up after yourself
+'''''''''''''''''''''''
+
+Remember to tear down any resources you set up in your tests. Don't use "YourModel.objects.all().delete()" to clean up your objects; it could be hiding bugs. Clean up exactly the resources you created.
+
+Test your setups and teardowns
+''''''''''''''''''''''''''''''
+
+To speed up analysis of broken tests, if you have a setUp() or tearDown() in a TestCase, add a test\_trivial() method which is empty. It will pass if your setUp() and tearDown() work.
+
+Views
+'''''
+
+All views should be thoroughly tested for security, checking to ensure that the proper HTTP codes are returned.
+
+- Test Anonymous User access
+- Test Permission based access
+- Test Superuser based access
+
+Check for invalid input.
+
+- missing fields
+- invalid data for field
+
+Templates & Javascript
+''''''''''''''''''''''
+
+The test suite does not yet include full selenium tests for verifying Javascript functionality. Some basic tests can be performed using Django's test suite:
+
+- Check objects in the context: forms, lists of objects, etc.
+- Check for existence of values in forms.
+
+See :ref:`selenium` for more information on what Selenium can test within GWM.
+
+
+
Any assert statement will take the optional kwarg of 'msg'. This kwarg
will be output instead of an error in the test. It is a very useful
argument for debugging.

diff --git a/docs/source/index.rst b/docs/source/index.rst
index cef6ec8..efe54f3 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -28,50 +28,63 @@ Getting Started
---------------
.. toctree::
:maxdepth: 1
+
getting_started/requirements
getting_started/installing
getting_started/configuring
getting_started/importing

-User Guide
+Deployment
----------
.. toctree::
:maxdepth: 1

- usage/upgrading
- usage/clusters
- usage/virtualmachines
- usage/nodes
- usage/templates
+ deployment/intro
+ deployment/apache
+ deployment/nginx
+
+Features
+--------
+.. toctree::
+ :maxdepth: 1
+
features/permissions
features/objectlog
features/vnc
features/sshkeys
features/ldap
features/templates
+
features/clusters
features/cluster-read-only
features/registration
features/caching
features/ganetiviz

+Usage
+-----
+.. toctree::
+ :maxdepth: 1
+
+ usage/upgrading
+ usage/clusters
+ usage/virtualmachines
+ usage/nodes
+ usage/templates
+
Contributing
------------
.. toctree::
:maxdepth: 1

dev/issues
+ dev/process

.. toctree::
:maxdepth: 2

dev/developers

-.. toctree::
- :maxdepth: 1
-
- dev/process
-

Project Information
-------------------
@@ -87,12 +100,7 @@ Project Information
project_info/license
project_info/faq
project_info/contributors
- usage/upgrading
- usage/clusters
- usage/virtualmachines
- usage/nodes
- usage/templates
-
+ project_info/release_cycle

References
~~~~~~~~~~

diff --git a/docs/source/dev/release.rst b/docs/source/project_info/release_cycle.rst
similarity index 98%
rename from docs/source/dev/release.rst
rename to docs/source/project_info/release_cycle.rst
index eb5b12a..9a0c52b 100644
--- a/docs/source/dev/release.rst
+++ b/docs/source/project_info/release_cycle.rst
@@ -1,4 +1,4 @@
-.. _release:
+.. _release_cycle:

Release Cycle
=============