* make compatible with pylint and pycodestyle
* black config
* flake8 compatible config
* Missing newline
* Add black check to CI and dev requirements
This commit updates the CI configuration and local tox configuration to
leverage black instead of pycodestyle. It adds a check job to ci and the
tox lint job so we can quickly check if black has been run. A tox job
named 'black' is added to run black on all the code in the repo.
* Run black on everything
This commit reformats all the code in the qiskit-terra repository to use
black. It changes no functionality in the project and just adjusts the
code formatting to be consistent and automated. If you are looking at
this commit in the git log you can likely safely ignore any diff from
this commit as it is just the result of running '`black' on the repo
and instead you should look at any commits before or after this for
functional changes.
Co-authored-by: Lev S. Bishop <18673315+levbishop@users.noreply.github.com>
* Add script to verify slow optional imports aren't used in default path
This commit adds a new script that is run in CI to find whether slow
optional imports are in the default qiskit import path. We've recently
had several instances of PRs being pushed that added sympy to the
default import path which makes the overall qiskit import significantly
slower (see #5576 for the most recent occurrence), this script will
catch those siutations and report the error.
* Use virtualenv in CI for running new script
The azure ci env was using system python instead of the venv where
qiskit-terra was installed for running the new script. This was causing
an error because to work the script imports qiskit to verify nothing
slow is getting imported. This commit fixes this by explicitly using the
venv python instead of the default system python to execute the script.
* Add script to makefile too
Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
* warning when make test
* before and after
Co-authored-by: Kevin Krsulich <kevin.krsulich@ibm.com>
Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
* Add support for attachments to test execution
By default in CI and with tox locally we run all the tests in parallel.
However, this makes things like printing to stdout, warnings on stderr,
or logging during tests difficult to deal with. This is because we'll
have multiple writers to the output streams simultaneously and no way
to figure out which text goes to which test. Luckily stestr and the
subunit protocl it uses internally has a method for adding attachments
to test results to handle this kind of case. Using this each output
stream is associated with the test which generated it and will get
displayed as such. The only issue with this is that the stdlib unittest
doesn't know how to write attachments to it's result stream. There is a
unittest extension library testtools[1] that provides this functionality
in a strictly compatible manner with unittest, however the current state
of the library needs some work before it can work well with more modern
features of stdlib unittest from python>3.5 so we either have to change
the tests to not use these features or come up with an alternative
solution for test attachments.
This commit ports the necessary result streaming functionality from
testtools into the QiskitTestCase base test class and then sets up the
appropriate fixtures to attach output streams from each test. This works
around the current limitation with testtools (I'm slowly working on
fixing this in testtools) but still provides the functionality. When
testtools is at the point it can be a drop in replacement for unittest
as terra is using it we can drop this code.
As part of this change all the test classes that define a setUp have a
missing super() call added. This framework does not work without setUp
in the base class being defined since that's what is used to setup the
stream capture. Moving forward the base test class actually enforces
that super() is called, otherwise the tests will fail.
[1] https://github.com/testing-cabal/testtools
* Fix lint
* Update contributing doc
* Fix copy paste error
* Add missing super calls from new tests
* Add missing super() calls and fix skip message
* Fix lint
Co-authored-by: Luciano Bello <luciano.bello@ibm.com>
* Set top level directory for legacy make test command
Normally for running unittests using tox is recommended [1] but a
Makefile is also available for people who were used to running tests
that way prior to the introduction of the tox config. The python
unittest discovery command set in the legacy test target in the
Makefile was not specifying a top level directory [2], this ends up
causing import error during loading with relative imports that go up a
directory because python can't resolve those if the import goes outside
the start directory. This wasn't an issue in tox or CI because the top
directory is implicitly set by stestr [3] the parallel runner used by
tox and CI. This commit fixes this issue for users of the make target
by setting the -t flag on the unittest discover command to to repo root
so the relative imports can be resolved.
Fixes#4939
[1] https://github.com/Qiskit/qiskit-terra/blob/master/CONTRIBUTING.md#test
[2] https://docs.python.org/3/library/unittest.html#test-discovery
[3] https://stestr.readthedocs.io/en/latest/MANUAL.html#configuration
* Actually set -t on the test target
* Add tools/verify_headers.py to check copyright headers
Currently we're relying on a pylint plugin to verify copyright headers
conform to the project guidelines. However this is problematic for a
number of reasons. The first is it has proven to be unstable there have
been several instances of both users and CI failing on header files that
do not have any issues. This is pretty common with pylint in general
since it's very sensitive to differences in environment. Additionally,
it was using a regex to try and match the entire header string. This
provided no practical debugability when it fails (especially when the
failure is unexpected) because we end up with only a match error.
This commit addresses these issues by removing the use of the regex
based pylint plugin and adding a small script to verify the header in
every qiskit file and provide useful debugging if there is an issue with
a header in a python file.
Fixes#3127
* Add toxinidir to tox script call
* Explicitly set character encoding for windows
In manual testing running the verify_headers.py script on windows would
fail because it was trying to use the system default character encoding
instead of utf8 and would encounter chartacters outside the windows
charmap encoding. To avoid this issue this commit explicitly sets the
character encoding to utf8. We already declare that in the header (which
is part of what this script is verifying) so we can assume all files are
utf8 encoded and if they're not the script will catch it.
Co-authored-by: Luciano Bello <luciano.bello@ibm.com>
* Add ability to run tests with pytest
* remove test/mock as it was a wrong location
Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
* Add randomized testing stage to travis.
* Update report_ci_failure to create an issue for failed random tests.
* Remove randomized tests from unit test and coverage.
* Add hypothesis example database to travis cache.
* Make test running concurrency dynamic based on nprocs
In #1228 we decreased the concurrency used for the test runner in CI to
avoid memory pressure and failing jobs. In that commit we set it to 2 as
a quick fix so we could unblock CI and continue landing patches. A
followup was to do the analysis and find the sweet spot for concurrency
and stability. At the same time we opened mtreinish/stestr#202 to add
support to the test runner for running fractional nprocs. That is still
under discussion, but in the meantime this commit adds support to the
makefile for using fractional nprocs concurrency. It adjusts are default
concurrency from 2 to be nprocs / 2 if nprocs > 3. This should enable us
to increase the number of test workers we run on travis linux jobs but
still maintain reliability.
* Hard code osx to 2 workers
* Add debug statement about core count and worker count
* Use printf to round floats to int
* Add test_ci make target, revert make test
Add a new "test_ci" target to the Makefile, aimed at being used by
the CIs. Update the "test" family of targets in order to revert
back to the behaviour that involves less overhead and complexity
for the users.
* Update travis in order to use test_ci
* Add documentation about test_ci target
* Remove legacy cpp code
* remove legacy cpp sim from make and travis
* Rename decorator and folder for aer provider tests
* remove Cpp simulator for setup.py
* fixup
* Remove all cmake and cleanup travis config
Since we're no longer building any C++ code there is no need to keep
cmake usage around anymore. This commit removes the last cmake remnants
and also cleans up the travis config to simply run make && make test to
install everything and then just invoke the test runner. It also
deduplicates jobs now that there is no distinction between no_compile
and compile jobs.
* Fix some small oversights
* Remove legacysimulator contributing doc section
* Cleaning up documentation
* Small updates
* Adding changes
* headings
* Heading
* More changes
* Small changes
* Additions
* Adding the Qiskit notebooks
* some typos
* Update to ibm
* Small updates
* replace logo for terra logo
* Replace parsed-literal with code-block
Replace blocks of command output with `..: code-block: text`, adjusting
the style to avoid syntax highlighting, copy-paste widget, and colored
background.
* Recover testing flags information into CONTRIB (#4)
* Slack link
Since enabling parallel test execution we're seeing a couple new issues
including failures caused by memory allocation issues in travis. This is
likely caused by increased memory pressue from running with nproc
workers, which on travis for linux means 32 workers. To decrease our
memory usage in CI and to also decrease the chances of a cross
interaction between tests running at the same time this commit changes
the test runner concurrency in travis runs to two workers instead of
nproc workers. Two workers is the least common demoniator between all
the travis environments (osx nodes only having 2 cpus), and since we
are using a fixed value that is used.
* Switch to stestr for test runner
This commit switches the default test runner for qiskit-terra to use
stestr instead of the built-in runner from stdlib unittest. By default
this switches the default mode of execution to be parallel instead of
serial which can lead to significant speed ups in test execution time.
Also the junitxml upload on the appveyor ci is switched to use the
subunit protocol instead of the xunit format. This is because subunit
is used natively by stestr. While we can generate xunit xml in the
same exact format it doesn't work on windows because of the subunit
library bug: https://bugs.launchpad.net/subunit/+bug/1322888 . Once
this bug is fixed we can convert the subunit to xunit xml as part of
the CI job. That being said though, the subunit data contains every
thing and whatever post processing is being done on the xml files
can easily be converted to use the subunit.
Closes#730
* Remove initial check for initializing state
The initializing state for a job is a transient condition. Depending on
how fast the test executes we may or may not be able to catch it during
the execution of the test. When running the test suite in parallel we're
seeing many instances where things execute too quickly and the assert
looking for the initial initializing state is too slow and the api
status has already moved on. This commit fixes this by simply removing
that check from all the tests since it can't be reliably checked.
* Stop writing progress bar to stdout during tests
This commit adjust the parallel_progress bar unit tests to mock out
sys.stdout.write() so we aren't actually writing the progress bar to
stdout during the test run. We're not actually verifying the contents
written to stdout anywhere in the tests and this both pollutes stdout
during a run and also fails when running tests under stestr on windows
ci, likely because of how python-subunit (a external dependency
library of stestr's) internally handles stdout encapsulation. So to
avoid these this commit mocks out the stdout writes and asserts we're at
least calling it. In the future we can adjust these to actually verify
the calls for the proper output. But for right now asserting we're even
calling sys.stdout.write() is an improvement and avoids the issues.
* Fix typos in tox.ini
* Change to per test method parallelization by default
Prior to this commit we were using test class level parallelization (ie
each test class is the minimum unit that gets passed to a worker). This
was done to optimize for the online tests which have expensive class
level constructors which we wouldn't want to run multiple times if the
individual test methods got split across multiple workers. However, this
was hurting the overall performance of the more common case where we
don't make actual api requests. This commit switches us to use per
method parallelization by default and manually switch to per class for
the online tests in CI.
* Revert "Change to per test method parallelization by default"
This reverts commit 0ab794b0a5bc14d23e1820042a70f66b0d68c99b.
* Update appveyor comments for using test_results.xml
This commit updates the comments in the appveyor to refer to the
upstream fix needed to leverage the test_results.xml. It also adds all
the necessary lines to properly generate an xunit xml file and upload
it.
* Fix Sphinx warnings and errors
Fix warnings related to `make doc`:
* Fix docstrings with invalid format, and small changelog issue.
* Remove jupyter functionality from autodoc due to failing imports.
* Fix wrong headings separators introduced by #697.
* Update release notes
Add introductory text and section about `QuantumProgram`, along with
placeholders for other entries.
Update backend and job sections for fixing links to classes and small
tunings overall.
* Add credentials section to release notes
* Fix reference and literal block
* updating 0.6 release notes
* more stuff for release notes
* Minor sphinx fixes (warnings, syntax)
* polish a bit
* Update releases.rst
Calling `job.status()` since it is a method, not a property.
* final small change
The current commit introduces several changes to the testing infrastructure.
First, it provides a way of running IBM-Q tests against pre-recorded responses. The software in charge of recording and mocking-up the responses is VCRPy[1] and it is configured and used in `test/common.py`. Cassettes can be updated by using `make test_recording`.
[1] https://github.com/kevin1024/vcrpy
The commit also includes the latest responses (under `tests/casettes`) for a successful test run but a default execution with `make test` will only use them if no IBM-Q credentials are found. To force a run against mocked responses, use `make test_mock`.
Finally, the commit also unifies the several test options in a unique environmental variable called `QISKIT_TESTS` (in `tests/python/_test_options.py`). These are the main equivalences but the set of options is described in the developer introduction [2]:
- `SKIP_SLOW_TESTS=False` is now achieved by `QISKIT_TESTS=run_slow`
- `SKIP_ONLINE_TESTS=1` is now achieved by `QISKIT_TESTS=skip_online`
[2] https://github.com/Qiskit/qiskit-terra/blob/master/doc/dev_introduction.rst#testing-options
Update the tooling used for the automatic documentation of the package
for using the latest versions of the packages involved, updating the
templates in the process.
Includes some cosmetical changes, and also fixes the issue of producing
files with the same name but with different capitalization that resulted
in issues in case-insensitive filesystems (ahem); by rendering the
private modules too (although orphaned) so the classes and members are
documented in those files.
* creating conf.py for German language
* initial German translation
* minor fixes and typos
* fixing typos and cleaning
* adding DE version
* fixing formatting issues
* fixing formatting issues
* formatting issues
* first DE version of index.rst
* fixing typos
* adding German translation de
* adding German translation
* adding German intro translation
* fixing minor typo
* adding German translation of real backend example
* minor typo
* adding German translation of getting started
* adding German translation of dev_introduction.rst
* fixing minor typos and beautification
* fixing title underline
* fixing image ref
* fixing broken links
* fixing broken reference
* fixing formatting issue
* add line in changelog
* remove note on downgrade requirements according to main doc
* Update CHANGELOG.rst
* minor fixes
* new dependencies target (make depend) for the qasm-simulator-cpp
(cherry picked from commit 3b253908a69101f14d37dac5ece4b51f0c9b80ec)
* changed to executable and bug fix
(cherry picked from commit ce8be89dac7fc0a40e39f0dbbf67cf32c072a4d0)
* assume yes for automatic pkg install
(cherry picked from commit 2cd7607db606753ae0aafa0b2fb8ffea30732dae)
* -march not supported on ppc64le. Use -mcpu instead
(cherry picked from commit 7cdab8ff632f2348d19b83b43781bf97f89c642b)
* bugfix
(cherry picked from commit 831692e34a89597e9c85706ab3e048d32e94f1f3)
* coverage rule in Makefile
* coverage in cmake
* clean coverage rule
* it looks like there is a proper way to remove the coverage data
* cmake: coverage_erase
* Add coverage target to cmake, fix typo
* Fix travis osx brew python (now upgrade)
Convert `qiskit.tools` to real Python modules by adding __init__.py,
adding lint and style fixes in the process.
Enable style and lint Travis check for qiskit.tools.
Minor fixes for the tests:
* use subtests in several places, for easier identification of the
failing assertions in loops.
* style, variable names, and typo fixes.
* add cleanup of the files generated by the tests to the `make clean`
target.
Fix the failing tests for the C++ simulator via:
* relaxing test_local_qiskit_simulator, just comparing that the keys
of get_counts match the expected ones instead of comparing the values
as well, due to an issue with randomness.
* start the unittest discovery on the "test/" directory, instead of the
root directory, as otherwise the QuantumCircuit header will be
modified by the time the C++ gate files are read (and the tests that
compare the lenghts of the QASMs will fail due to the extra
definitions).
Make the `executable` a class configuration key for the C++ simulator
instead of a qobj key, allowing the auto-discovery mechanism to pick
the two classes automatically if the executable is present. Two
locations are attempted by default (one is the standard one when using
the repository, the other one when using pip), which can be overriden
in the `configuration['exe']` parameter of the constructor if needed.
Style, linting and whitespace fixes.
* Changed default path of the simulator to:
1st - The path where the simulator is built by default from the
Makefile
2nd - The path where pip installs simulator binary
* Removed .gitignore entries that are not needed anymore
* Integrate simulator's make clean target into the main Makefile
* Relax the pylint output disabling several warnings.
* Reintroduce the linting of qiskit.extensions and qiskit.qasm.node.
* Add a `style` target to the Makefile that performs pycodestyle, and
reduce the verbosity of `lint` by removing the report.
* Update the Travis configuration in order to add a new step that
performs linter and style checks via an environment variable.
* Added japanese doc
* Update Make and structure to allow multiple langs
Update the Makefile "doc" target to build both the English and the
Japanese versions, in separate directories, and the "clean" target to
cleanup the autodoc documentation.
Add a "conf.py" file to the "doc/ja" folder that modifies the relevant
variables, as Sphinx uses that folder as the root document folder when
building the Japanese version.
* Fix missing "install" reference on ja sphinx docs
* Update sphinx doc deploy script for Japanese
Add the Japanese sphinx produced directory to the Github pages deploy
script.
* Fix typo and extra line in Makefile
* Add runtime check for IBMQuantumExperience version
Add `qiskit._util._check_ibmqe_version()` (invoked on the main import)
for emitting a warning if the installed version of IBMQuantumExperience
does not match the version defined on `setup.py`.
* Rename requires.txt and requires-dev.txt
Rename to "requirements.txt" and "requirements-dev.txt", in order to
conform better to the de-facto practices.
Update the requirements to match the versions specified in setup.py.
* setup.py: OS classifiers, backend, IBMQE version
* Explicitly require IBMQuantumExperience>=1.8.13, as older versions
might not contain all the functionality needed.
* Include "qiskit.backends" as a package instead of "qiskit.simulators".
* Add trove classifiers for the operative systems supported.
* Fix PEP8 warnings for long description.
* Avoid using __version__ in setup.py due to imports
Revert the change of using "__version__" imported from "__init__.py"
directly on "setup.py", as the current importing of the modules from
"__init__.py" causes the building to fail due to the dependencies not
being available at the time of invocation.
Make the default linter configuration less strict, reducing the number
of false positives and the usefulness of the existing output with a
combination of:
* ignoring specific files entirely (such as the parser or the standard
extension individual files)
* ignore specific warnings on some files (such as "invalid-name" on
files that use variables mapped to mathematic algorithms)
* disable specific tags globaly (in particular, "no-self-use")
Also make the linter more strict when it comes to docstrings via the
"pylint.extensions.docparams" plugin.
Fix duplicated entries on the Table of Contents caused by the
qiskit.extensions.standard module importing symbols with the same name
as the submodules by unifying the output of the better-apidoc template.
Revert to using "doc/_autodoc" as the single output folder for the .rst.
Reorganize the summary generated for the modules, splitting the members
into several sections. Revise the generation of the TOC so links to the
stubs and the public docs are included on the sidebar.
Lev Bishop