Skip to content

Commit

Permalink
Bug 984528 - Rename manifestdestiny -> manifestparser. r=ahal
Browse files Browse the repository at this point in the history
--HG--
rename : testing/mozbase/docs/manifestdestiny.rst => testing/mozbase/docs/manifestparser.rst
rename : testing/mozbase/manifestdestiny/manifestparser/__init__.py => testing/mozbase/manifestparser/manifestparser/__init__.py
rename : testing/mozbase/manifestdestiny/manifestparser/manifestparser.py => testing/mozbase/manifestparser/manifestparser/manifestparser.py
rename : testing/mozbase/manifestdestiny/setup.py => testing/mozbase/manifestparser/setup.py
rename : testing/mozbase/manifestdestiny/tests/comment-example.ini => testing/mozbase/manifestparser/tests/comment-example.ini
rename : testing/mozbase/manifestdestiny/tests/default-skipif.ini => testing/mozbase/manifestparser/tests/default-skipif.ini
rename : testing/mozbase/manifestdestiny/tests/filter-example.ini => testing/mozbase/manifestparser/tests/filter-example.ini
rename : testing/mozbase/manifestdestiny/tests/fleem => testing/mozbase/manifestparser/tests/fleem
rename : testing/mozbase/manifestdestiny/tests/include-example.ini => testing/mozbase/manifestparser/tests/include-example.ini
rename : testing/mozbase/manifestdestiny/tests/include/bar.ini => testing/mozbase/manifestparser/tests/include/bar.ini
rename : testing/mozbase/manifestdestiny/tests/include/crash-handling => testing/mozbase/manifestparser/tests/include/crash-handling
rename : testing/mozbase/manifestdestiny/tests/include/flowers => testing/mozbase/manifestparser/tests/include/flowers
rename : testing/mozbase/manifestdestiny/tests/include/foo.ini => testing/mozbase/manifestparser/tests/include/foo.ini
rename : testing/mozbase/manifestdestiny/tests/just-defaults.ini => testing/mozbase/manifestparser/tests/just-defaults.ini
rename : testing/mozbase/manifestdestiny/tests/manifest.ini => testing/mozbase/manifestparser/tests/manifest.ini
rename : testing/mozbase/manifestdestiny/tests/mozmill-example.ini => testing/mozbase/manifestparser/tests/mozmill-example.ini
rename : testing/mozbase/manifestdestiny/tests/mozmill-restart-example.ini => testing/mozbase/manifestparser/tests/mozmill-restart-example.ini
rename : testing/mozbase/manifestdestiny/tests/no-tests.ini => testing/mozbase/manifestparser/tests/no-tests.ini
rename : testing/mozbase/manifestdestiny/tests/path-example.ini => testing/mozbase/manifestparser/tests/path-example.ini
rename : testing/mozbase/manifestdestiny/tests/relative-path.ini => testing/mozbase/manifestparser/tests/relative-path.ini
rename : testing/mozbase/manifestdestiny/tests/test_convert_directory.py => testing/mozbase/manifestparser/tests/test_convert_directory.py
rename : testing/mozbase/manifestdestiny/tests/test_convert_symlinks.py => testing/mozbase/manifestparser/tests/test_convert_symlinks.py
rename : testing/mozbase/manifestdestiny/tests/test_default_skipif.py => testing/mozbase/manifestparser/tests/test_default_skipif.py
rename : testing/mozbase/manifestdestiny/tests/test_expressionparser.py => testing/mozbase/manifestparser/tests/test_expressionparser.py
rename : testing/mozbase/manifestdestiny/tests/test_manifestparser.py => testing/mozbase/manifestparser/tests/test_manifestparser.py
rename : testing/mozbase/manifestdestiny/tests/test_read_ini.py => testing/mozbase/manifestparser/tests/test_read_ini.py
rename : testing/mozbase/manifestdestiny/tests/test_testmanifest.py => testing/mozbase/manifestparser/tests/test_testmanifest.py
rename : testing/mozbase/manifestdestiny/tests/verifyDirectory/subdir/manifest.ini => testing/mozbase/manifestparser/tests/verifyDirectory/subdir/manifest.ini
rename : testing/mozbase/manifestdestiny/tests/verifyDirectory/subdir/test_sub.js => testing/mozbase/manifestparser/tests/verifyDirectory/subdir/test_sub.js
rename : testing/mozbase/manifestdestiny/tests/verifyDirectory/test_1.js => testing/mozbase/manifestparser/tests/verifyDirectory/test_1.js
rename : testing/mozbase/manifestdestiny/tests/verifyDirectory/test_2.js => testing/mozbase/manifestparser/tests/verifyDirectory/test_2.js
rename : testing/mozbase/manifestdestiny/tests/verifyDirectory/test_3.js => testing/mozbase/manifestparser/tests/verifyDirectory/test_3.js
rename : testing/mozbase/manifestdestiny/tests/verifyDirectory/verifyDirectory.ini => testing/mozbase/manifestparser/tests/verifyDirectory/verifyDirectory.ini
rename : testing/mozbase/manifestdestiny/tests/verifyDirectory/verifyDirectory_incomplete.ini => testing/mozbase/manifestparser/tests/verifyDirectory/verifyDirectory_incomplete.ini
rename : testing/mozbase/manifestdestiny/tests/verifyDirectory/verifyDirectory_toocomplete.ini => testing/mozbase/manifestparser/tests/verifyDirectory/verifyDirectory_toocomplete.ini
  • Loading branch information
wlach committed Jun 10, 2014
1 parent a71f67c commit 543aa42
Show file tree
Hide file tree
Showing 46 changed files with 36 additions and 36 deletions.
2 changes: 1 addition & 1 deletion b2g/test/b2g-unittest-requirements.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
ManifestDestiny==0.5.6
manifestparser==0.5.7
mozprocess==0.9
mozprofile==0.6
mozrunner==5.15
Expand Down
14 changes: 7 additions & 7 deletions build/docs/test_manifests.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Test Manifests
Many test suites have their test metadata defined in files called
**test manifests**.

Test manifests are divided into two flavors: :ref:`manifest_destiny_manifests`
Test manifests are divided into two flavors: :ref:`manifestparser_manifests`
and :ref:`reftest_manifests`.

Naming Convention
Expand All @@ -34,16 +34,16 @@ xpcshell.ini
webapprt.ini
For the *chrome* flavor of webapp runtime mochitests.

.. _manifest_destiny_manifests:
.. _manifestparser_manifests:

Manifest Destiny Manifests
ManifestParser Manifests
==========================

Manifest destiny manifests are essentially ini files that conform to a basic
ManifestParser manifests are essentially ini files that conform to a basic
set of assumptions.

The `reference documentation <http://mozbase.readthedocs.org/en/latest/manifestdestiny.html>`_
for manifest destiny manifests describes the basic format of test manifests.
The `reference documentation <http://mozbase.readthedocs.org/en/latest/manifestparser.html>`_
for manifestparser manifests describes the basic format of test manifests.

In summary, manifests are ini files with section names describing test files::

Expand Down Expand Up @@ -166,7 +166,7 @@ The expressions can reference a well-defined set of variables, such as
the :ref:`mozinfo documentation <mozinfo_attributes>`.

See
`the source <https://hg.mozilla.org/mozilla-central/file/default/testing/mozbase/manifestdestiny/manifestparser/manifestparser.py>`_ for the full documentation of the
`the source <https://hg.mozilla.org/mozilla-central/file/default/testing/mozbase/manifestparser/manifestparser/manifestparser.py>`_ for the full documentation of the
expression syntax until it is documented here.

.. todo::
Expand Down
2 changes: 1 addition & 1 deletion build/mach_bootstrap.py
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@
'testing/mozbase/mozinfo',
'testing/mozbase/moztest',
'testing/mozbase/mozversion',
'testing/mozbase/manifestdestiny',
'testing/mozbase/manifestparser',
'xpcom/idl-parser',
]

Expand Down
2 changes: 1 addition & 1 deletion testing/config/mozbase_requirements.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
../mozbase/manifestdestiny
../mozbase/manifestparser
../mozbase/mozcrash
../mozbase/mozdevice
../mozbase/mozfile
Expand Down
2 changes: 1 addition & 1 deletion testing/marionette/client/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
./transport
manifestdestiny
manifestparser
mozhttpd >= 0.5
mozinfo >= 0.7
mozprocess >= 0.9
Expand Down
2 changes: 1 addition & 1 deletion testing/mochitest/Makefile.in
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ SERV_FILES = \
$(topsrcdir)/testing/mozbase/mozdevice/mozdevice/devicemanager.py \
$(topsrcdir)/testing/mozbase/mozdevice/mozdevice/devicemanagerADB.py \
$(topsrcdir)/testing/mozbase/mozdevice/mozdevice/devicemanagerSUT.py \
$(topsrcdir)/testing/mozbase/manifestdestiny/manifestparser/manifestparser.py \
$(topsrcdir)/testing/mozbase/manifestparser/manifestparser/manifestparser.py \
$(topsrcdir)/testing/mozbase/mozdevice/mozdevice/droid.py \
$(topsrcdir)/testing/mozbase/mozdevice/mozdevice/Zeroconf.py \
$(topsrcdir)/testing/mozbase/moznetwork/moznetwork/moznetwork.py \
Expand Down
2 changes: 1 addition & 1 deletion testing/mochitest/runtests.py
Original file line number Diff line number Diff line change
Expand Up @@ -505,7 +505,7 @@ def path_sort(ob1, ob2):

paths.sort(path_sort)

# Bug 883865 - add this functionality into manifestDestiny
# Bug 883865 - add this functionality into manifestparser
with open(os.path.join(SCRIPT_DIR, 'tests.json'), 'w') as manifestFile:
manifestFile.write(json.dumps({'tests': paths}))
options.manifestFile = 'tests.json'
Expand Down
2 changes: 1 addition & 1 deletion testing/mozbase/Makefile.in
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ include $(topsrcdir)/config/rules.mk

# Harness packages from the srcdir
MOZBASE_PACKAGES = \
manifestdestiny \
manifestparser \
mozcrash \
mozfile \
mozhttpd \
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,13 @@ platform or build of Mozilla. To handle these cases (and more), we
created a python library to create and use test "manifests", which
codify this information.

:mod:`manifestdestiny` --- Create and manage test manifests
:mod:`manifestparser` --- Create and manage test manifests
-----------------------------------------------------------

manifestdestiny lets you easily create and use test manifests, to
manifestparser lets you easily create and use test manifests, to
control which tests are run under what circumstances.

What ManifestDestiny gives you:
What manifestparser gives you:

* manifests are ordered lists of tests
* tests may have an arbitrary number of key, value pairs
Expand All @@ -24,14 +24,14 @@ What ManifestDestiny gives you:
.. code-block:: text
[{'expected': 'pass',
'path': '/home/mozilla/mozmill/src/ManifestDestiny/manifestdestiny/tests/testToolbar/testBackForwardButtons.js',
'path': '/home/mozilla/mozmill/src/manifestparser/manifestparser/tests/testToolbar/testBackForwardButtons.js',
'relpath': 'testToolbar/testBackForwardButtons.js',
'name': 'testBackForwardButtons.js',
'here': '/home/mozilla/mozmill/src/ManifestDestiny/manifestdestiny/tests',
'manifest': '/home/mozilla/mozmill/src/ManifestDestiny/manifestdestiny/tests/manifest.ini',}]
'here': '/home/mozilla/mozmill/src/manifestparser/manifestparser/tests',
'manifest': '/home/mozilla/mozmill/src/manifestparser/manifestparser/tests/manifest.ini',}]
The keys displayed here (path, relpath, name, here, and manifest) are
reserved keys for ManifestDestiny and any consuming APIs. You can add
reserved keys for manifestparser and any consuming APIs. You can add
additional key, value metadata to each test.

Why have test manifests?
Expand Down Expand Up @@ -173,7 +173,7 @@ as well.

Outside of the reserved keys, the remaining key, values
are up to convention to use. There is a (currently very minimal)
generic integration layer in ManifestDestiny for use of all harnesses,
generic integration layer in manifestparser for use of all harnesses,
`manifestparser.TestManifest`.
For instance, if the 'disabled' key is present, you can get the set of
tests without disabled (various other queries are doable as well).
Expand Down Expand Up @@ -201,7 +201,7 @@ To recap:
* you can use it however you want or process it further as you need

Tests are denoted by sections in an .ini file (see
http://hg.mozilla.org/automation/ManifestDestiny/file/tip/manifestdestiny/tests/mozmill-example.ini).
http://hg.mozilla.org/automation/manifestparser/file/tip/manifestparser/tests/mozmill-example.ini).

Additional manifest files may be included with an `[include:]` directive:

Expand All @@ -216,10 +216,10 @@ The `[DEFAULT]` section contains variables that all tests inherit from.
Included files will inherit the top-level variables but may override
in their own `[DEFAULT]` section.

ManifestDestiny Architecture
manifestparser Architecture
````````````````````````````

There is a two- or three-layered approach to the ManifestDestiny
There is a two- or three-layered approach to the manifestparser
architecture, depending on your needs:

1. ManifestParser: this is a generic parser for .ini manifests that
Expand All @@ -234,9 +234,9 @@ test-specific. TestManifest faciliates `skip-if` and `run-if` logic.
from TestManifest if more harness-specific customization is desired at
the manifest level.

See the source code at https://github.com/mozilla/mozbase/tree/master/manifestdestiny
See the source code at https://github.com/mozilla/mozbase/tree/master/manifestparser
and
https://github.com/mozilla/mozbase/blob/master/manifestdestiny/manifestparser.py
https://github.com/mozilla/mozbase/blob/master/manifestparser/manifestparser.py
in particular.

Using Manifests
Expand Down Expand Up @@ -270,7 +270,7 @@ is up to the harness to pass in tags appropriate to its usage.
Creating Manifests
``````````````````

ManifestDestiny comes with a console script, `manifestparser create`, that
manifestparser comes with a console script, `manifestparser create`, that
may be used to create a seed manifest structure from a directory of
files. Run `manifestparser help create` for usage information.

Expand Down Expand Up @@ -386,9 +386,9 @@ To update from a directory of tests in `~/mozmill/src/mozmill-tests/firefox/` ru
Tests
`````

ManifestDestiny includes a suite of tests:
manifestparser includes a suite of tests:

https://github.com/mozilla/mozbase/tree/master/manifestdestiny/tests
https://github.com/mozilla/mozbase/tree/master/manifestparsery/tests

`test_manifest.txt` is a doctest that may be helpful in figuring out
how to use the API. Tests are run via `python test.py`.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

from setuptools import setup

PACKAGE_NAME = "ManifestDestiny"
PACKAGE_NAME = "manifestparser"
PACKAGE_VERSION = '0.6'

setup(name=PACKAGE_NAME,
Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ class TestManifestParser(unittest.TestCase):
"""
Test the manifest parser
You must have ManifestDestiny installed before running these tests.
You must have manifestparser installed before running these tests.
Run ``python manifestparser.py setup develop`` with setuptools installed.
"""

Expand Down
2 changes: 1 addition & 1 deletion testing/mozbase/mozprofile/setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
# we only support python 2 right now
assert sys.version_info[0] == 2

deps = ['ManifestDestiny >= 0.5.4',
deps = ['manifestparser >= 0.6',
'mozfile >= 1.0',
'mozlog']

Expand Down
2 changes: 1 addition & 1 deletion testing/mozbase/packages.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
manifestdestiny.pth:testing/mozbase/manifestdestiny
manifestparser.pth:testing/mozbase/manifestparser
mozb2g.pth:testing/mozbase/mozb2g
mozcrash.pth:testing/mozbase/mozcrash
mozdevice.pth:testing/mozbase/mozdevice
Expand Down
4 changes: 2 additions & 2 deletions testing/mozbase/test-manifest.ini
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@
# file, You can obtain one at http://mozilla.org/MPL/2.0/.

# mozbase test manifest, in the format of
# http://mozbase.readthedocs.org/en/latest/manifestdestiny.html
# http://mozbase.readthedocs.org/en/latest/manifestparser.html

# run with
# https://github.com/mozilla/mozbase/blob/master/test.py

[include:manifestdestiny/tests/manifest.ini]
[include:manifestparser/tests/manifest.ini]
[include:mozcrash/tests/manifest.ini]
[include:mozdevice/tests/manifest.ini]
[include:mozfile/tests/manifest.ini]
Expand Down

0 comments on commit 543aa42

Please sign in to comment.