66b57dbea6cf92285325a7d05aeb2521f08be2a2
[piuparts/piuparts.git] / TODO
1 Things to do for piuparts
2 =========================
3
4 Please also check the BTS, especially the bugs with a severity higher than
5 wishlist!
6
7
8 for 0.5x:
9
10 - make piuparts-master + piuparts-slave packages work with documented steps:
11   - do not enable sudoers.d/piuparts-slave in p-s.deb, neither the cronjobs.
12     - this is manual work one has done once after installation. we only
13       document whats needs to be done how.
14   - the shipped crontabs are not suitable from cron.d/ due to missing user
15     column -> provide instructions how to install them as piuparts(s|m) user
16     from /u/s/doc/p-(s|m)/examples
17   - verify that all scripts in $user/bin/ also work from master-slave packages
18     eventually enable some conjobs in the packages
19   - slave.postinst should setup '~piupartsm/.ssh/authorized_keys' using triggers
20     dpkg-trigger piuparts-master-please-install-the-slave-key
21     + the current method only works if -slave is configured after -master
22     - maybe do this manually again as well?
23
24 - Documentation related:
25   - examples are duplicated in piuparts.1.txt and README.txt - only keep one copy.
26   - README_server has some duplication information on configuration as well.
27   - link wiki:piuparts/UseCases||UsageTips in README_1st (after we agreed on a name)
28   - add a sample config with all possible keys set to some useful value
29     (like /usr/share/doc/apt/examples/configure-index.gz)
30
31 - more stats and graphs:
32   - packages processed per day and section
33     - master writes submissions.txt per section since 0.45
34   - # of open bugs with tag piuparts
35   - generate https://piuparts.debian.org/stable/states.png + testing.png from
36     existing data
37   - generate simple diagrams: number of source + binary package in all single distros:
38     squeeze, wheezy, jessie, sid.
39   - move counts.txt from htdocs to master.
40
41 - piuparts.conf.pejacevic: use mirror via nfs (faster)
42
43
44 for 0.6x:
45
46 - maybe compress all logfiles
47
48 - look for a solution to use the global debian mirror for debian-backports,
49   too, to avoid hardcoding a specific mirror in distros.conf
50
51 - really support multiple architectures:
52   - piuparts-report should have a list of available arch and list packages only
53     available on untested archs in a new state
54     "(depends-)not-available-on-tested-archs"
55   - master should (per default) only schedule packages which are not available
56     on the master arch to slaves of different archs ->
57     "schedule-evenly-to-slaves = no"
58
59 - piuparts-master: keep track of to whom a reservation was given
60
61 - if it weren't for 'slave-bin/slave_cleanup', the slave would only need
62   rights to run "sudo piuparts" but nothing else. If we can clean this up,
63   the sudoers.d should recommend sudo (lsof|kill|umount) for admins.
64
65 - if there were real schroot support, piuparts could be used without sudo.
66   (#708663)
67
68 - generate piuparts.1.txt automatically from piuparts.py - see this blog post
69   for a nice howto:
70   http://andialbrecht.wordpress.com/2009/03/17/creating-a-man-page-with-distutils-and-optparse/
71   - though this seems pretty complicated... maybe rather grep for
72     parser.add_option and help= in piuparts.py ?!
73     - requires merging all the additional infomation in piuparts.1.txt into piuarts.py
74     - parsing piuparts --help output may be easier than parsing piuparts.py
75
76 - check the logfiles (especially pass/) for
77   - "Exception in thread"
78   - java stacktraces
79   - "Can't locate .* in @INC"
80
81
82 for 0.7x and later:
83
84 - install from git/Makefile: remove the need for /etc/piuparts
85
86 - accept a PIUPARTS_CONF environment variable everywhere to point to a different
87   piuparts.conf
88
89 - write reportbug-like wrapper for mass bug filing (start simple, make it more
90   sophisticated later).
91
92 - rework known_problems:
93   - split detect_well_known_errors
94     - parsing the logfiles should stay there
95     - generating the html should be integrated into piuparts-report
96   - use a number prefix for sorting
97   - add title information
98   - piuparts-report: "discover" the available known_problems, dont hardcode the
99     list
100   - drop _issue/_error duplication, have flags inside to indicate thether to
101     generate _issues.tpl (pass/) and/or _error.tpl (fail/ bugged/ affected/)
102   - rework known problems to a python-friendlier format
103
104 - the templates used by update-reports.py and detect_well_known_errors should
105   be taken from /etc/piuparts/templates/ and not be included in the python source
106
107 - a redirect of http://piuparts.d.o/foo to http://p.d.o/source/f/foo.html would
108   be nice
109
110
111 for 0.8x and later:
112
113 - find_default_debian_mirrors: 
114   - check whether find_default_debian_mirrors produces something useful if
115     sources.list does not exist (and sources.list.d/*.list is there instead)
116   - maybe just copy sources.list(.d/*) instead?
117
118 - make it possible to call aptitude (or similar) instead of apt-get and allow to
119   override the commandline arguments.
120
121 - mounting /proc and perhaps others (usbfs, sysfs, /dev/pts, etc.) in the chroot
122   might be a good idea because some packages might need this.
123
124 - rewrite piuparts-analyze to run over all sections and cache BTS responses
125
126 - "decorate" (strike-through) bug links generated by piuparts-analyze to
127   indicate resolved state (take package version into account!)
128
129 - report:
130   - write stats about the reasons for failures, as its done with shell scripts
131     now (piuparts-analyze.py is an existing "fragment".)
132   - RSS feeds of logs
133   - do more fancy R graphs, eg. also per state
134   - link (and target) to piuparts.d.o configuration is static to pejacevic. should
135     refer to the actual hosts configuration if running somewhere else
136
137 - not sure if it's a sensible thing to to, but provide a way to turn off
138   debugging output for piuparts.py - see
139   http://docs.python.org/library/logging.html
140
141 - commandline-switches for all programms
142
143 - move shell cronjobs functionality into master, slave & report
144
145 - automated testing of piuparts using an archive of known broken packages:
146   - create archive of broken packages to provide test cases for piuparts testing.
147   - create emacspeak-broken-dpkg-preconfigure package for broken repo. (then later
148     put more broken packages in there and use that for testing piuparts)