Commit graph

144 commits

Author SHA1 Message Date
Adrien Ferrand
3d0e16ece3 [Windows|Unix] Rewrite bash scripts for tests into python (#6435)
Certbot relies heavily on bash scripts to deploy a development environment and to execute tests. This is fine for Linux systems, including Travis, but problematic for Windows machines.

This PR converts all theses scripts into Python, to make them platform independant.

As a consequence, tox-win.ini is not needed anymore, and tox can be run indifferently on Windows or on Linux using a common tox.ini. AppVeyor is updated accordingly to execute tests for acme, certbot and all dns plugins. Other tests are not executed as they are for Docker, unsupported Apache/Nginx/Postfix plugins (for now) or not relevant for Windows (explicit Linux distribution tests or pylint).

Another PR will be done on certbot website to update how a dev environment can be set up.

* Replace several shell scripts by python equivalent.

* Correction on tox coverage

* Extend usage of new python scripts

* Various corrections

* Replace venv construction bash scripts by python equivalents

* Update tox.ini

* Unicode lines to compare files

* Put modifications on letsencrypt-auto-source instead of generated scripts

* Add executable permissions for Linux.

* Merge tox win tests into main tox

* Skip lock_test on Windows

* Correct appveyor config

* Update appveyor.yml

* Explicit coverage py27 or py37

* Avoid to cover non supported certbot plugins on Windows

* Update tox.ini

* Remove specific warnings during CI

* No cover on a debug code for tests only.

* Update documentation and help script on venv/venv3.py

* Customize help message for Windows

* Quote correctly executable path with potential spaces in it.

* Copy pipstrap from upstream
2018-11-07 17:16:16 -08:00
ohemorange
d53ef1f7c2
Add mypy info to Certbot docs (#6033)
* Add mypy info to Certbot docs

* break up lines

* link to mypy docs and links to https

* Expand on import wording

* be consistent about mypy styling
2018-05-31 13:57:23 -07:00
Brad Warren
dec97fc126 Revert "Add link to pycon issues (#5959)"
This reverts commit 68359086ff.
2018-05-18 17:48:30 -07:00
James Hiebert
42ef252043 Adds a note about Python3 in the Developer Guide (#5998) 2018-05-15 07:58:33 -07:00
Brad Warren
cce23c86c7
partially revert #5953 (#5964) 2018-05-14 08:08:24 -07:00
Brad Warren
68359086ff
Add link to pycon issues (#5959)
* add link to pycon issues

* add especially
2018-05-13 08:06:19 -07:00
Brad Warren
9568f9d5b0
Add instructions on how to ask for help (#5957)
* Add instructions on how to ask for help

* s/setup/set up
2018-05-11 10:52:45 -07:00
Brad Warren
2f89a10f50
Small dev docs improvements (#5953)
* Clarify UNIX only

* Have people develop natively.

Some systems like Arch Linux and macOS require --debug in order to install
dependencies.

Our bootstrapping script for macOS works, so let's let people who want to
develop natively.

* briefly mention docker as dev option

* remove bad _common.sh info

* update OS dep section

* Remove sudo from certbot-auto usage

When sudo isn't available, Certbot is able to fall back to su. Removing it from
the instructions here allows the command to work when its run in minimal
systems like Docker where sudo may not be installed.

* copy advice about missing interpreters

* Improve integration tests docs

Explain what a boulder is and tell people they probably should just let the
tests run in Travis.

* Don't tell people to run integration tests.

I don't think any paid Certbot devs run integration tests locally and instead
rely on Travis. Let's not make others do it.

* fix spacing

* you wouldn't download a CA

* address review comments
2018-05-11 07:07:02 -07:00
Brad Warren
f510f4bddf
Update good volunteer task to good first issue. (#5891) 2018-04-24 06:38:15 -07:00
Edelita Valdez
f01aa1295f Add quotes to command for docs extras. 2018-03-20 23:40:44 -07:00
Edelita Valdez
a26a78e84e Add note to developer guide docs about installing docs extras. (#4946) 2018-03-17 19:24:14 -07:00
sydneyli
3077b51500
Merge pull request #5749 from certbot/fix-docker-link
Fix Docker link
2018-03-16 18:15:05 -07:00
Brad Warren
d4834da0f4 fix docker link 2018-03-16 17:48:46 -07:00
ohemorange
5ecb68f2ed Update instances of acme-staging url to acme-staging-v02 (#5734)
* update instances of acme-staging url to acme-staging-v02

* keep example client as v1

* keep deactivate script as v1
2018-03-16 15:24:55 -07:00
Hugo
42638afc75 Drop support for EOL Python 2.6 and 3.3
* Drop support for EOL Python 2.6

* Use more helpful assertIn/NotIn instead of assertTrue/False

* Drop support for EOL Python 3.3

* Remove redundant Python 3.3 code

* Restore code for RHEL 6 and virtualenv for Py2.7

* Revert pipstrap.py to upstream

* Merge py26_packages and non_py26_packages into all_packages

* Revert changes to *-auto in root

* Update by calling letsencrypt-auto-source/build.py

* Revert permissions for pipstrap.py
2018-02-16 16:14:01 -08:00
Peter Eckersley
abc4a27613 [Docs] restore docs for ppl just using Certbot git master (#5420)
- Dev / test cycles are one use case for the "running a local copy of
 the client" instructions, but simply running bleeding edge Certbot is
 another
 - So edit the docs to once again explain how to just run bleeding edge
 Certbot, without (say) always getting staging certs.
2018-02-12 14:07:33 -08:00
Jacob Hoffman-Andrews
530a9590e6 Add sudo to certbot-auto instructions. (#5501) 2018-02-07 14:08:03 -08:00
Andrew Ittner
ed23290232 Clean up Sphinx errors (#4706)
Also minor copyedits, suppress unhelpful errors, mark files that should
*not* be in the TOC as hidden.
2017-05-26 20:57:14 -07:00
Noah Swartz
227743b7e4 Merge pull request #4459 from St-Ranger/patch-1
Improved info for FreeBSD
2017-04-14 11:46:08 -07:00
St-Ranger
d11443ac05 Missing word is inserted. 2017-04-13 20:36:32 -05:00
Noah Swartz
8fea513dec Merge pull request #4455 from zjs/topic/zjs/developer-guide
Documentation improvements for plugin developers
2017-04-13 16:54:51 -07:00
Noah Swartz
07273e5d7e Merge pull request #4432 from certbot/contributing-common
Document tests/integration/_common.sh.
2017-04-10 19:15:18 -07:00
Jacob Hoffman-Andrews
a08e9599f5 Review feedback. 2017-04-07 10:15:52 -07:00
St-Ranger
035e5b93ea Futher improvement re: FreeBSD packages
Further improved the previous change to make it more clear.
2017-04-04 00:41:55 -05:00
St-Ranger
4c36d8081e Correct info fro FreeBSD
1. Replace the outdated reference to "vritualenv", "see below" -> "see above".
2. Replace the awkward sentence (partially incorrect) about installing on FreeBSD. 
It can be installed via different ways: "pkg" is not exclusive. I am not aware of any reason why it canNOT be installed from ports. Some people prefer build and install everything from ports. (The previous version of the description implies that ports cannot be used.)
2017-04-03 23:45:48 -05:00
Zach Shepherd
22248c1393 docs: fix syntax error in plugin installation example
Partially addresses issue #4368.
2017-04-03 14:58:25 -07:00
Zach Shepherd
af5fd4f6bd docs: use monospace syntax for method name 2017-04-03 14:55:27 -07:00
Zach Shepherd
3f625d3a0d docs: clarify the use of entry points for plugins
The documentation did not list the entry point group, certbot.plugins.

Partially addresses issue #4368.
2017-04-03 14:51:48 -07:00
Zach Shepherd
c1cb762b32 docs: clarify when venv needs to be re-setup
When dependencies change or a new plugin is introduced, the venv needs
to be re-created.

Partially addresses issue #4368.
2017-04-03 14:33:41 -07:00
Jacob Hoffman-Andrews
e73c29374a Change to source. 2017-03-29 14:32:02 -07:00
Jacob Hoffman-Andrews
db0a4f9039 Document tests/integration/_common.sh.
This makes it much easier to run certbot during development.
2017-03-28 16:15:09 -07:00
Jacob Hoffman-Andrews
672f206309 Improve plugin-writing docs. (#4329)
Move "Writing your own plugin" under Code components and layout, with the other
plugin docs.

Include instructions on how to install a plugin into a virtualenv and how to check
for its presence.

Document that users can install third-party plugins systemwide, but not with
certbot-auto.

Remove obsolete information from Authenticators section and make the section
more informative.

Remove IDisplay sub-section since it repeats information in the main "Plugin
architecture" section.
2017-03-17 13:13:45 -07:00
Brad Warren
91f4b2b571 Improve macOS contributor instructions (#4327)
* remove instructions about removed Vagrantfile

* rewrite docker instructions

* say where docker-compose can be run

* give better intro for macOS devs

* prompt people for permission to install OS packages

* reword awkward sentence

* Change WORKDIR to /opt/certbot/src

This change is OK because all paths used in Dockerfile-dev are absolute paths.

* remove 'cd src' instructions for Dockerfile-dev

* Improve docker-compose testing instructions
2017-03-10 17:27:09 -08:00
Brad Warren
4a2582dda4 Remove broken known issues link (#4294) 2017-03-06 17:31:28 -08:00
Jacob Hoffman-Andrews
ea578870da ipdb can now be run without pip installing. (#4257) 2017-03-03 10:37:31 -08:00
Jacob Hoffman-Andrews
ebf5170d12 Update testing docs. (#4211)
Recommend faster-running commands with clearer output first, building up to
slow, noisy, `tox` last.

Remove outdated Boulder testing advice, and outdated Boulder testing scripts
(Vagrantfile, mac-bootstrap.sh, boulder-start.sh). Update Boulder testing
section.

Fill out "directory structure" section of contributing guide a little better.
2017-02-16 12:39:17 -08:00
Josh Soref
6a39a42f45 Spelling (#4101)
* spelling: action

* spelling: artifacts

* spelling: asymmetric

* spelling: attempts

* spelling: bizarre

* spelling: certbot

* spelling: certificate

* spelling: certainly

* spelling: challenge

* spelling: client

* spelling: collated

* spelling: correct

* spelling: considered

* spelling: custom

* spelling: distinguish

* spelling: encoding

* spelling: enhancement

* spelling: equivalent

* spelling: execution

* spelling: existence

* spelling: failed

* spelling: handshake

* spelling: hyphen

* spelling: initialized

* spelling: initialization

* spelling: interpretation

* spelling: letsencrypt

* spelling: multiline

* spelling: multipart

* spelling: necessary

* spelling: otherwise

* spelling: output

* spelling: overridden

* spelling: positives

* spelling: preferable

* spelling: progress

* spelling: recommended

* spelling: referring

* spelling: relativity

* spelling: request

* spelling: requiring

* spelling: separate

* spelling: source

* spelling: specified

* spelling: standard

* spelling: successfully

* spelling: unparseable

* spelling: useful
2017-01-26 16:21:54 -08:00
Peter Eckersley
169b30aa90 Fix reference to letsencrypt-auto (#4085) 2017-01-19 13:50:07 -08:00
Brad Warren
bb669528b3 Remove old references to pep8 in our code (#4073) 2017-01-19 11:21:25 -08:00
Lipis
bba5d7d950 Rename OS X -> macOS (#3965)
* Rename OS X -> macOS

* Revert *-auto
2017-01-10 12:24:15 -08:00
Nick Fong
b0e4054b53 Add information on updating [certbot|letsencrypt]-auto (#3983)
* Add information on updating [certbot|letsencrypt]-auto

See #3703

* Add more information about when [le|cb]-auto is updated
2017-01-07 16:45:44 -08:00
Erica Portnoy
3b233df2b1 Update docs/contributing.rst to match display behavior during release. (#3674) 2017-01-04 14:42:52 -05:00
Jacob Hoffman-Andrews
e49a41be34 Change "hacking" to "getting started" in the docs 2016-08-08 12:17:42 -07:00
Brad Warren
7a0d4d48a0 Remove broken known issues link 2016-07-25 12:54:14 -07:00
bmw
950710bdce Merge pull request #3042 from TheNavigat/envlist
Limiting tox envlist to really needed tests
2016-06-17 12:37:17 -07:00
Amjad Mashaal
31d9fc7d86 Adding --skip-missing-interpreters to constributing.rst "Submitting a pull request" section 2016-06-17 04:13:44 +02:00
Noah Swartz
092173c608 fix broken link in contributing.rst (#3130) 2016-06-06 17:05:51 -07:00
Amjad Mashaal
4a8f71277c Limiting tox envlist to really needed tests 2016-05-28 02:03:51 +02:00
Noah Swartz
4b1d9e0af2 Merge pull request #2986 from certbot/doc-cleanup
Doc cleanup
2016-05-16 20:14:02 -07:00
John Reed
1aff941ad0 Updating broken link to Google Python Style guide
Old link: https://google-styleguide.googlecode.com/svn/trunk/pyguide.html
New link: https://google.github.io/styleguide/pyguide.html
2016-05-13 18:37:43 -05:00