wanted: a setuptools plugin to make unit tests be executed with trial instead of with pyunit #505
Labels
No labels
c/code
c/code-dirnodes
c/code-encoding
c/code-frontend
c/code-frontend-cli
c/code-frontend-ftp-sftp
c/code-frontend-magic-folder
c/code-frontend-web
c/code-mutable
c/code-network
c/code-nodeadmin
c/code-peerselection
c/code-storage
c/contrib
c/dev-infrastructure
c/docs
c/operational
c/packaging
c/unknown
c/website
kw:2pc
kw:410
kw:9p
kw:ActivePerl
kw:AttributeError
kw:DataUnavailable
kw:DeadReferenceError
kw:DoS
kw:FileZilla
kw:GetLastError
kw:IFinishableConsumer
kw:K
kw:LeastAuthority
kw:Makefile
kw:RIStorageServer
kw:StringIO
kw:UncoordinatedWriteError
kw:about
kw:access
kw:access-control
kw:accessibility
kw:accounting
kw:accounting-crawler
kw:add-only
kw:aes
kw:aesthetics
kw:alias
kw:aliases
kw:aliens
kw:allmydata
kw:amazon
kw:ambient
kw:annotations
kw:anonymity
kw:anonymous
kw:anti-censorship
kw:api_auth_token
kw:appearance
kw:appname
kw:apport
kw:archive
kw:archlinux
kw:argparse
kw:arm
kw:assertion
kw:attachment
kw:auth
kw:authentication
kw:automation
kw:avahi
kw:availability
kw:aws
kw:azure
kw:backend
kw:backoff
kw:backup
kw:backupdb
kw:backward-compatibility
kw:bandwidth
kw:basedir
kw:bayes
kw:bbfreeze
kw:beta
kw:binaries
kw:binutils
kw:bitcoin
kw:bitrot
kw:blacklist
kw:blocker
kw:blocks-cloud-deployment
kw:blocks-cloud-merge
kw:blocks-magic-folder-merge
kw:blocks-merge
kw:blocks-raic
kw:blocks-release
kw:blog
kw:bom
kw:bonjour
kw:branch
kw:branding
kw:breadcrumbs
kw:brians-opinion-needed
kw:browser
kw:bsd
kw:build
kw:build-helpers
kw:buildbot
kw:builders
kw:buildslave
kw:buildslaves
kw:cache
kw:cap
kw:capleak
kw:captcha
kw:cast
kw:centos
kw:cffi
kw:chacha
kw:charset
kw:check
kw:checker
kw:chroot
kw:ci
kw:clean
kw:cleanup
kw:cli
kw:cloud
kw:cloud-backend
kw:cmdline
kw:code
kw:code-checks
kw:coding-standards
kw:coding-tools
kw:coding_tools
kw:collection
kw:compatibility
kw:completion
kw:compression
kw:confidentiality
kw:config
kw:configuration
kw:configuration.txt
kw:conflict
kw:connection
kw:connectivity
kw:consistency
kw:content
kw:control
kw:control.furl
kw:convergence
kw:coordination
kw:copyright
kw:corruption
kw:cors
kw:cost
kw:coverage
kw:coveralls
kw:coveralls.io
kw:cpu-watcher
kw:cpyext
kw:crash
kw:crawler
kw:crawlers
kw:create-container
kw:cruft
kw:crypto
kw:cryptography
kw:cryptography-lib
kw:cryptopp
kw:csp
kw:curl
kw:cutoff-date
kw:cycle
kw:cygwin
kw:d3
kw:daemon
kw:darcs
kw:darcsver
kw:database
kw:dataloss
kw:db
kw:dead-code
kw:deb
kw:debian
kw:debug
kw:deep-check
kw:defaults
kw:deferred
kw:delete
kw:deletion
kw:denial-of-service
kw:dependency
kw:deployment
kw:deprecation
kw:desert-island
kw:desert-island-build
kw:design
kw:design-review-needed
kw:detection
kw:dev-infrastructure
kw:devpay
kw:directory
kw:directory-page
kw:dirnode
kw:dirnodes
kw:disconnect
kw:discovery
kw:disk
kw:disk-backend
kw:distribute
kw:distutils
kw:dns
kw:do_http
kw:doc-needed
kw:docker
kw:docs
kw:docs-needed
kw:dokan
kw:dos
kw:download
kw:downloader
kw:dragonfly
kw:drop-upload
kw:duplicity
kw:dusty
kw:earth-dragon
kw:easy
kw:ec2
kw:ecdsa
kw:ed25519
kw:egg-needed
kw:eggs
kw:eliot
kw:email
kw:empty
kw:encoding
kw:endpoint
kw:enterprise
kw:enum34
kw:environment
kw:erasure
kw:erasure-coding
kw:error
kw:escaping
kw:etag
kw:etch
kw:evangelism
kw:eventual
kw:example
kw:excess-authority
kw:exec
kw:exocet
kw:expiration
kw:extensibility
kw:extension
kw:failure
kw:fedora
kw:ffp
kw:fhs
kw:figleaf
kw:file
kw:file-descriptor
kw:filename
kw:filesystem
kw:fileutil
kw:fips
kw:firewall
kw:first
kw:floatingpoint
kw:flog
kw:foolscap
kw:forward-compatibility
kw:forward-secrecy
kw:forwarding
kw:free
kw:freebsd
kw:frontend
kw:fsevents
kw:ftp
kw:ftpd
kw:full
kw:furl
kw:fuse
kw:garbage
kw:garbage-collection
kw:gateway
kw:gatherer
kw:gc
kw:gcc
kw:gentoo
kw:get
kw:git
kw:git-annex
kw:github
kw:glacier
kw:globalcaps
kw:glossary
kw:google-cloud-storage
kw:google-drive-backend
kw:gossip
kw:governance
kw:grid
kw:grid-manager
kw:gridid
kw:gridsync
kw:grsec
kw:gsoc
kw:gvfs
kw:hackfest
kw:hacktahoe
kw:hang
kw:hardlink
kw:heartbleed
kw:heisenbug
kw:help
kw:helper
kw:hint
kw:hooks
kw:how
kw:how-to
kw:howto
kw:hp
kw:hp-cloud
kw:html
kw:http
kw:https
kw:i18n
kw:i2p
kw:i2p-collab
kw:illustration
kw:image
kw:immutable
kw:impressions
kw:incentives
kw:incident
kw:init
kw:inlineCallbacks
kw:inotify
kw:install
kw:installer
kw:integration
kw:integration-test
kw:integrity
kw:interactive
kw:interface
kw:interfaces
kw:interoperability
kw:interstellar-exploration
kw:introducer
kw:introduction
kw:iphone
kw:ipkg
kw:iputil
kw:ipv6
kw:irc
kw:jail
kw:javascript
kw:joke
kw:jquery
kw:json
kw:jsui
kw:junk
kw:key-value-store
kw:kfreebsd
kw:known-issue
kw:konqueror
kw:kpreid
kw:kvm
kw:l10n
kw:lae
kw:large
kw:latency
kw:leak
kw:leasedb
kw:leases
kw:libgmp
kw:license
kw:licenss
kw:linecount
kw:link
kw:linux
kw:lit
kw:localhost
kw:location
kw:locking
kw:logging
kw:logo
kw:loopback
kw:lucid
kw:mac
kw:macintosh
kw:magic-folder
kw:manhole
kw:manifest
kw:manual-test-needed
kw:map
kw:mapupdate
kw:max_space
kw:mdmf
kw:memcheck
kw:memory
kw:memory-leak
kw:mesh
kw:metadata
kw:meter
kw:migration
kw:mime
kw:mingw
kw:minimal
kw:misc
kw:miscapture
kw:mlp
kw:mock
kw:more-info-needed
kw:mountain-lion
kw:move
kw:multi-users
kw:multiple
kw:multiuser-gateway
kw:munin
kw:music
kw:mutability
kw:mutable
kw:mystery
kw:names
kw:naming
kw:nas
kw:navigation
kw:needs-review
kw:needs-spawn
kw:netbsd
kw:network
kw:nevow
kw:new-user
kw:newcaps
kw:news
kw:news-done
kw:news-needed
kw:newsletter
kw:newurls
kw:nfc
kw:nginx
kw:nixos
kw:no-clobber
kw:node
kw:node-url
kw:notification
kw:notifyOnDisconnect
kw:nsa310
kw:nsa320
kw:nsa325
kw:numpy
kw:objects
kw:old
kw:openbsd
kw:openitp-packaging
kw:openssl
kw:openstack
kw:opensuse
kw:operation-helpers
kw:operational
kw:operations
kw:ophandle
kw:ophandles
kw:ops
kw:optimization
kw:optional
kw:options
kw:organization
kw:os
kw:os.abort
kw:ostrom
kw:osx
kw:osxfuse
kw:otf-magic-folder-objective1
kw:otf-magic-folder-objective2
kw:otf-magic-folder-objective3
kw:otf-magic-folder-objective4
kw:otf-magic-folder-objective5
kw:otf-magic-folder-objective6
kw:p2p
kw:packaging
kw:partial
kw:password
kw:path
kw:paths
kw:pause
kw:peer-selection
kw:performance
kw:permalink
kw:permissions
kw:persistence
kw:phone
kw:pickle
kw:pip
kw:pipermail
kw:pkg_resources
kw:placement
kw:planning
kw:policy
kw:port
kw:portability
kw:portal
kw:posthook
kw:pratchett
kw:preformance
kw:preservation
kw:privacy
kw:process
kw:profile
kw:profiling
kw:progress
kw:proxy
kw:publish
kw:pyOpenSSL
kw:pyasn1
kw:pycparser
kw:pycrypto
kw:pycrypto-lib
kw:pycryptopp
kw:pyfilesystem
kw:pyflakes
kw:pylint
kw:pypi
kw:pypy
kw:pysqlite
kw:python
kw:python3
kw:pythonpath
kw:pyutil
kw:pywin32
kw:quickstart
kw:quiet
kw:quotas
kw:quoting
kw:raic
kw:rainhill
kw:random
kw:random-access
kw:range
kw:raspberry-pi
kw:reactor
kw:readonly
kw:rebalancing
kw:recovery
kw:recursive
kw:redhat
kw:redirect
kw:redressing
kw:refactor
kw:referer
kw:referrer
kw:regression
kw:rekey
kw:relay
kw:release
kw:release-blocker
kw:reliability
kw:relnotes
kw:remote
kw:removable
kw:removable-disk
kw:rename
kw:renew
kw:repair
kw:replace
kw:report
kw:repository
kw:research
kw:reserved_space
kw:response-needed
kw:response-time
kw:restore
kw:retrieve
kw:retry
kw:review
kw:review-needed
kw:reviewed
kw:revocation
kw:roadmap
kw:rollback
kw:rpm
kw:rsa
kw:rss
kw:rst
kw:rsync
kw:rusty
kw:s3
kw:s3-backend
kw:s3-frontend
kw:s4
kw:same-origin
kw:sandbox
kw:scalability
kw:scaling
kw:scheduling
kw:schema
kw:scheme
kw:scp
kw:scripts
kw:sdist
kw:sdmf
kw:security
kw:self-contained
kw:server
kw:servermap
kw:servers-of-happiness
kw:service
kw:setup
kw:setup.py
kw:setup_requires
kw:setuptools
kw:setuptools_darcs
kw:sftp
kw:shared
kw:shareset
kw:shell
kw:signals
kw:simultaneous
kw:six
kw:size
kw:slackware
kw:slashes
kw:smb
kw:sneakernet
kw:snowleopard
kw:socket
kw:solaris
kw:space
kw:space-efficiency
kw:spam
kw:spec
kw:speed
kw:sqlite
kw:ssh
kw:ssh-keygen
kw:sshfs
kw:ssl
kw:stability
kw:standards
kw:start
kw:startup
kw:static
kw:static-analysis
kw:statistics
kw:stats
kw:stats_gatherer
kw:status
kw:stdeb
kw:storage
kw:streaming
kw:strports
kw:style
kw:stylesheet
kw:subprocess
kw:sumo
kw:survey
kw:svg
kw:symlink
kw:synchronous
kw:tac
kw:tahoe-*
kw:tahoe-add-alias
kw:tahoe-admin
kw:tahoe-archive
kw:tahoe-backup
kw:tahoe-check
kw:tahoe-cp
kw:tahoe-create-alias
kw:tahoe-create-introducer
kw:tahoe-debug
kw:tahoe-deep-check
kw:tahoe-deepcheck
kw:tahoe-lafs-trac-stream
kw:tahoe-list-aliases
kw:tahoe-ls
kw:tahoe-magic-folder
kw:tahoe-manifest
kw:tahoe-mkdir
kw:tahoe-mount
kw:tahoe-mv
kw:tahoe-put
kw:tahoe-restart
kw:tahoe-rm
kw:tahoe-run
kw:tahoe-start
kw:tahoe-stats
kw:tahoe-unlink
kw:tahoe-webopen
kw:tahoe.css
kw:tahoe_files
kw:tahoewapi
kw:tarball
kw:tarballs
kw:tempfile
kw:templates
kw:terminology
kw:test
kw:test-and-set
kw:test-from-egg
kw:test-needed
kw:testgrid
kw:testing
kw:tests
kw:throttling
kw:ticket999-s3-backend
kw:tiddly
kw:time
kw:timeout
kw:timing
kw:to
kw:to-be-closed-on-2011-08-01
kw:tor
kw:tor-protocol
kw:torsocks
kw:tox
kw:trac
kw:transparency
kw:travis
kw:travis-ci
kw:trial
kw:trickle
kw:trivial
kw:truckee
kw:tub
kw:tub.location
kw:twine
kw:twistd
kw:twistd.log
kw:twisted
kw:twisted-14
kw:twisted-trial
kw:twitter
kw:twn
kw:txaws
kw:type
kw:typeerror
kw:ubuntu
kw:ucwe
kw:ueb
kw:ui
kw:unclean
kw:uncoordinated-writes
kw:undeletable
kw:unfinished-business
kw:unhandled-error
kw:unhappy
kw:unicode
kw:unit
kw:unix
kw:unlink
kw:update
kw:upgrade
kw:upload
kw:upload-helper
kw:uri
kw:url
kw:usability
kw:use-case
kw:utf-8
kw:util
kw:uwsgi
kw:ux
kw:validation
kw:variables
kw:vdrive
kw:verify
kw:verlib
kw:version
kw:versioning
kw:versions
kw:video
kw:virtualbox
kw:virtualenv
kw:vista
kw:visualization
kw:visualizer
kw:vm
kw:volunteergrid2
kw:volunteers
kw:vpn
kw:wapi
kw:warners-opinion-needed
kw:warning
kw:weapi
kw:web
kw:web.port
kw:webapi
kw:webdav
kw:webdrive
kw:webport
kw:websec
kw:website
kw:websocket
kw:welcome
kw:welcome-page
kw:welcomepage
kw:wiki
kw:win32
kw:win64
kw:windows
kw:windows-related
kw:winscp
kw:workaround
kw:world-domination
kw:wrapper
kw:write-enabler
kw:wui
kw:x86
kw:x86-64
kw:xhtml
kw:xml
kw:xss
kw:zbase32
kw:zetuptoolz
kw:zfec
kw:zookos-opinion-needed
kw:zope
kw:zope.interface
p/blocker
p/critical
p/major
p/minor
p/normal
p/supercritical
p/trivial
r/cannot reproduce
r/duplicate
r/fixed
r/invalid
r/somebody else's problem
r/was already fixed
r/wontfix
r/worksforme
t/defect
t/enhancement
t/task
v/0.2.0
v/0.3.0
v/0.4.0
v/0.5.0
v/0.5.1
v/0.6.0
v/0.6.1
v/0.7.0
v/0.8.0
v/0.9.0
v/1.0.0
v/1.1.0
v/1.10.0
v/1.10.1
v/1.10.2
v/1.10a2
v/1.11.0
v/1.12.0
v/1.12.1
v/1.13.0
v/1.14.0
v/1.15.0
v/1.15.1
v/1.2.0
v/1.3.0
v/1.4.1
v/1.5.0
v/1.6.0
v/1.6.1
v/1.7.0
v/1.7.1
v/1.7β
v/1.8.0
v/1.8.1
v/1.8.2
v/1.8.3
v/1.8β
v/1.9.0
v/1.9.0-s3branch
v/1.9.0a1
v/1.9.0a2
v/1.9.0b1
v/1.9.1
v/1.9.2
v/1.9.2a1
v/cloud-branch
v/unknown
No project
No assignees
3 participants
Notifications
Due date
No due date set.
Dependencies
No dependencies set.
Reference: tahoe-lafs/trac#505
Loading…
Add table
Reference in a new issue
No description provided.
Delete branch "%!s()"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
Currently we use a script [misc/find_trial.py]source:misc/find_trial.py@2895 to find a trial executable and then the [Makefile]source:Makefile@2895 executes it. It would be nicer if
./setup.py test
would use trial instead of pyunit to run tests. See also #179 (rewrite our Makefile in Python instead of GNUmake).I'm ok with this as long as I can still exercise as much control over the test process as I have now. That means:
Something like
./setup.py test allmydata.test.test_mutable
, orPYTHONPATH=~/my-foolscap ./setup.py test
.If/when this gets in, I'll change the Makefile so that 'make test' is just an alias for ./setup.py test .
One question is how much automatic-dependency-management this step ought to do. I recommend doing nothing.
Our Makefile currently has the
test
target compute dependencies first and thequicktest
target which just executes the test. We added the latter because measurements showed that it took on the order of 5 seconds to compute the dependencies, and you (Brian) have a very fast edit-test cycle which cannot stand a 5-second delay in the middle of it. We preserved the version that also computed the dependencies because new users who just runmake test
need dependencies built and because I don't like the weird version skew issues if I pull patches which change the dependencies and then I run tests afterward without first runningmake
.Would a similar pair of "quick test" and "dependency-building test" commands in the setuptools plugin satisfy you?
Yes. Maybe something like "setup.py test --no-deps" for the quick version.. once I get it into my command history (or I add it to a Makefile alias), I'll be ok.
The argument to control which tests get run is important too, that'll probably just be the remaining sys.argv elements after the options are pulled out.
I have a plugin hosted here: http://code.google.com/p/trialtest/
It currently adds a 'trial' command to distutils, which is like 'test' only it uses trial instead of pyunit. It doesn't appear that I can replace the existing 'test' command using a plugin. If we want 'setup.py test' to use the trial functionality, then we'll just have to override it in tahoe's setup.py with a cmdclass.
How do we add to tahoe's setup.py a cmdclass to make it use trialtest for the
test
command?Okay now we've got to make sure that all of Brian's requirements are met.
First of all, how can we make it not resolve dependencies when running tests? This might be tricky. Actually Brian's requirement isn't that it leaves dependencies unresolved, but rather his requirement is that it launches the tests very quickly -- something like ... let's see how fast
make quicktest TEST=allmydata.test.test_base62.T.test_ende_0x00
currently works on my machine...Hm. Let's say we have a budget of 800 milliseconds to launch the test. I don't believe it will be possible to do the setuptools dependency checking and still meet that budget, which means we need to have a
--no-deps
option.Cool! So it sort of works! Here's what I get here, attached.
The problems I have is probably because
./setup.py trial
doesn't set the PYTHONPATH and the PATH the waymake test
does.Attachment zooko._setup_py.log.txt (76020 bytes) added
result of "./setup.py trial"
Attachment zooko.make_test_.log.txt (57399 bytes) added
result of "make test" (everything passes in this file, not in the "./setup.py test" file)
The problem with those tests failing was not with the PATH's not being set, but because the reactor wasn't being set to poll. I reproduced this by running:
So I am currently working on adding an option to the TrialTest command to choose the reactor, but I haven't yet figured out how to pass this option through the trial script itself.
No, I'm pretty sure the problem on my machine is that somehow it is trying to invoke "trial" and "trial" is not on the path. Here's the excerpt from my
zooko._setup_py.log.txt
:Attachment twistd_exe.patch (1072 bytes) added
Patch to fall back on finding twisted executables in source/bin.
Okay, after applying the twistd_exe.patch, I realized that our source:setup.py is not setup_require'ing twisted as it needs to do in order to make this ticket work. Commenting-in that setup_require's line yields the following result from
./setup.py trial
:So then I re-ran it like this to run just one of the failing tests:
The complete stdout and stderr from this will be attached to this ticket, and here is the main result:
Attachment zooko._setup_py.log.2.txt (40654 bytes) added
stderr and stdout from running "./setup.py trial -s allmydata.test.test_runner.RunNode.test_client"
Here is an excerpt from the log file produced by the test node in this test:
the full log of the test node (which is named "_trial_temp/test_runner/RunNode/test_client/c1/logs/twistd.log") will be attached...
Attachment twistd.log (2546 bytes) added
_trial_temp/test_runner/RunNode/test_client/c1/logs/twistd.log
I don't know how we are going to accomplish the
./setup.py trial --no-deps
option -- my guess is that it requires some help fromsetuptools
itself. Fortunately, it occurs to me that Brian (who requires no-deps) can keep using the makefile'squicktest
target, which will not go through thesetuptools_trial
plugin at all, but will continue doing its current thing (invokingtrial
directly).I don't want Brian's method of invoking tests to diverge from other people's in the long term, so I would want to make progress on the
./setup.py trial --no-deps
option in parallel, possibly by submitting a patch tosetuptools
if need be.sounds good to me. The extra routine in setup.py will manage sys.path and locate trial, right?
If so I'll apply this in a few days.
thanks!
It occurs to me that the most recent patch from Chris -- twistd_exe.patch -- finds the twisted executables and adds their directory to the
sys.path
, but does not also add them to theos.environ['PATH']
. That means that subprocesses won't have that on their path. However, it doesn't seem like that could explain the error I get:ImportError: No module named allmydata
.zooko: are the transcripts you are attaching the result of using Chris' patch? Or his plugin? Or are they the result of some other change to setup.py? You say "It sort of works" but I'm not sure which "It" you're referring to :)
The most recent transcripts I posted are the result of using Chris's plugin and his find_twistd.exe patch, and editing our setup.py to have "twisted" in its setup_requires parameter. Note that this is a second attempt after the earlier attempt in which I wrote "it sort of works" -- Chris write the find_twistd.exe patch and I applied it in order to get past the problem of that earlier attempt -- lack of twistd on the PATH.
ok, I'm going to see if there's a way to copy Chris's plugin into our setup.py, as well as including the find_twistd.exe patch. Tell me if I'm wrong, but I think this will result in a simpler solution than trying to incorporate a setuptools plugin (I don't know how setuptools plugins work).
Using the setuptools plugin actually makes it simpler and reusable. There are other projects who are also interested in being able to use this plugin to run their unit tests with trial. BTW, I ended up being busier this week than I thought, so I probably won't be able to help out until Friday :/
In a fit of activity, I pushed a bunch of changes that took care of this. Specifically, it added a 'setup.py trial' command, which interacts with a number of other tahoe-specific changes that I made to simplify our Makefile drastically.
This probably isn't general enough to satisfy the original goals of this ticket, but it makes Tahoe work much better (all of the shell-quoting from the Makefile is gone, replaced by python code in setup.py). The code from setup.py could probably be extracted into a separate plugin, but I'm not sure it's worth it.
The code is here: http://allmydata.org/trac/tahoe/browser/setup.py?rev=77d7f63e39d5968d#L316 .
That said, I love to see code reused, so I'd like to hear everybody's thoughts on turning this stuff into a plugin of some sort.
So Chris Galvan has already made a setuptools plugin which mostly works. It sounds like if he just examines your patch and copies into his plugin any parts of your patch which are sufficiently non-Tahoe-specific, then we can probably switch to using his plugin.
Attachment use_setuptools_trial.patch (95348 bytes) added
Modify setup.py to use the setuptools_trial plugin
I have attached a patch that modifies the setup.py so that it uses the setuptools_trial plugin. The plugin itself allows you to pass different arguments such as reporter, reactor, etc..., but in tahoe's setup.py I sub-class the class in the plugin so that we can set certain arguments to default(i.e. set the reactor to poll on certain platforms).
Thanks for the patch, Chris! We might want to bundle setuptools_trial in which the Tahoe slim distribution, the way we do with setuptools_darcs and darcsver.
Brian said he would have a look at this soon.
Re-assigning to Chris.
We have been using the setuptools_trial plugin for awhile now and seems to be working pretty well, so I'm going to close this ticket.