Tutti i miei sbagli (Errori di un wannabe Open Source Developer)

Tutti i miei sbagli

Andrea Francia

andrea@andreafrancia.it – http://andreafrancia.it

Saturday, March 24, 12 1

Tutti i miei sbagli
Errori di un wannabe Open Source Developer

Andrea Francia

2 @andreafrancia #trash-cli

Il progetto
Gli errori
Contenuti Qualcosa di giusto
Conclusioni
Applausi


trash-cli

https://github.com/andreafrancia/trash-cli


Open Source

GPLv2


Linux


$ trash


$ trash ./foo


$ list-trash

2012-03-02 19:43:44 /Users/andrea/foo


$ trash a_dir/foo
$ trash another_dir/foo


$ list-trash
2012-03-02 19:43:44 /home/andrea/foo
2012-03-02 19:50:04 /home/andrea/a_dir/…
2012-03-02 19:50:05 /home/andrea/anothe…


$ restore-trash
0 2012-03-02 19:43:44 /home/andrea/foo
1 2012-03-02 19:50:04 /home/andrea/a_d…
2 2012-03-02 19:50:05 /home/andrea/ano…
File to restore? [0..2]:


$ empty-trash


KDE XFCE

Gnome

Generic Naming Issue


Protagonisti


I nomi dei comandi

$ trash

$ list-trash

$ empty-trash

$ restore-trash


Come funziona Fedora


Un revisore
di Fedora


Distribuzioni

Come funzionano?


2X Absolute AbulÉdu AgiliaLinux Alinex aLinux Alpine ALT Ankur Bangla AnNyung antiX APODIO aptosid
Arch ArchBang ArcheOS AriOS Ark ArtistX Asianux Astaro AsteriskNOW Asturix Aurora AUSTRUMI AV
Linux BackBox BackTrack Baltix Bardinux Bayanihan BeakOS Berry BigLinux Bio-Linux blackPanther BLAG
BlankOn Bodhi BOSS BRLix Burapha CAELinux CAINE Caixa Mágica Calculate Canaima Caos Càtix CCux
CDlinux CensorNet CentOS Chakra ClearOS Clonezilla Comfusion Commodore Connochaet Coyote CrunchBang
CRUX CTKArch Debian DebXPde Deepin DEFT DesktopBSD Devil DigAnTel DoudouLinux Draco DragonFly Dragora
Dreamlinux Dream Studio dyne:bolic EasyPeasy Edubuntu Ekaaty Elastix elementary Endian Epidemic Estrella
Roja ESUN Evinux ExTiX Fedora Fermi Finnix Foresight FreeBSD FreeNAS Frenzy Frugalware Fuduntu
FuguIta Funtoo Fusion GeeXboX Gentoo Gentoox GhostBSD Gibraltar GnackTrack GParted Greenie Grml
Guadalinex Hacao Haiku Hanthana Helix IDMS Imagineos Inquisitor Insigne IPCop IPFire Jibbed JoLinux Joli
OS K12Linux kademar KahelOS KANOTIX Karoshi Kiwi Knoppel KNOPPIX KnoSciences Kongoni Kororaa
Kubuntu Kwort Leeenux Legacy LFS LinHES Linpus LinuxConsole Linux-EduCD linuX-gamers LinuxTLE Linvo
Liquid Lemur Litrix LliureX LPS Lubuntu Lunar m0n0wall Macpup Madbox Mageia Magic Mandriva
Mangaka Matriux MAX MEPIS MidnightBSD MiniNo MINIX Mint Miracle MirOS MoLinux Momonga
Monomaxos moonOS Musix Myrinix Mythbuntu Nature's NetBSD Netrunner NetSecL Nexenta NexentaStor
NST NuTyX Ojuba OLPC Omoikane O-Net OpenBSD Openfiler OpenIndiana openmamba OpenMediaVault
openSUSE Openwall Open Xange Ophcrack Oracle Otakux Overclockix PAIPIX paldo PapugLinux Parabola
Pardus Parsix Parted Magic PC-BSD PCLinuxOS Pear PelicanHPC Pentoo Peppermint pfSense Phayoune Pinguy
Plamo PLD Plop Porteus Poseidon pQui Privatix Proxmox PUIAS Puppy Puredyne PureOS Qimo Qomo Quirky
Red Flag Red Hat Redo redWall Resulinux RIPLinuX Rocks Cluster ROSA Runtu Sabayon Sabily SalineOS
Salix SAMity Satux SchilliX Scientific Securepoint Semplice siduction Skolelinux Slackware SliTaz SME
Ser ver SmoothWall SMS Snowlinux SoL Solaris Sorcerer Source Mage STD StressLinux SuliX SuperGamer
Super OS SuperX Suriyan SUSE Swift Syllable SystemRescue T2 Tails Tango Studio TFM Thinstation Tiny
Core TinyMe Toorox Toutou Trinity Trisquel trixbox Tuquito Turbolinux TurnKey UberStudent Ubuntu Ubuntu
DP Ubuntu Rescue Ubuntu Studio UHU-Linux Ulteo Ultimate Unity Untangle UPR Userful UTUTO Vector
VENENUX Vine Vinux VLOS VMKnoppix VortexBox Vyatta wattOS Webconverger Wifislax xPUD Xubuntu
Yellow Dog Ylmf Yoper Zentyal Zenwalk Zeroshell ZevenOS Zorin

From of http://distrowatch.com/

2X Absolute AbulÉdu AgiliaLinux Alinex aLinux Alpine ALT Ankur Bangla AnNyung antiX APODIO aptosid
Arch ArchBang ArcheOS AriOS Ark ArtistX Asianux Astaro AsteriskNOW Asturix Aurora AUSTRUMI AV
Linux BackBox BackTrack Baltix Bardinux Bayanihan BeakOS Berry BigLinux Bio-Linux blackPanther BLAG
BlankOn Bodhi BOSS BRLix Burapha CAELinux CAINE Caixa Mágica Calculate Canaima Caos Càtix CCux
CDlinux CensorNet CentOS Chakra ClearOS Clonezilla Comfusion Commodore Connochaet Coyote CrunchBang
CRUX CTKArch Debian DebXPde Deepin DEFT DesktopBSD Devil DigAnTel DoudouLinux Draco DragonFly Dragora
Dreamlinux Dream Studio dyne:bolic EasyPeasy Edubuntu Ekaaty Elastix elementary Endian Epidemic Estrella
Roja ESUN Evinux ExTiX Fedora Fermi Finnix Foresight FreeBSD FreeNAS Frenzy Frugalware Fuduntu
FuguIta Funtoo Fusion GeeXboX Gentoo Gentoox GhostBSD Gibraltar GnackTrack GParted Greenie Grml
Guadalinex Hacao Haiku Hanthana Helix IDMS Imagineos Inquisitor Insigne IPCop IPFire Jibbed JoLinux Joli
OS K12Linux kademar KahelOS KANOTIX Karoshi Kiwi Knoppel KNOPPIX KnoSciences Kongoni Kororaa
Kubuntu Kwort Leeenux Legacy LFS LinHES Linpus LinuxConsole Linux-EduCD linuX-gamers LinuxTLE Linvo
Liquid Lemur Litrix LliureX LPS Lubuntu Lunar m0n0wall Macpup Madbox Mageia Magic Mandriva
Mangaka Matriux MAX MEPIS MidnightBSD MiniNo MINIX Mint Miracle MirOS MoLinux Momonga
Monomaxos moonOS Musix Myrinix Mythbuntu Nature's NetBSD Netrunner NetSecL Nexenta NexentaStor
NST NuTyX Ojuba OLPC Omoikane O-Net OpenBSD Openfiler OpenIndiana openmamba OpenMediaVault
openSUSE Openwall Open Xange Ophcrack Oracle Otakux Overclockix PAIPIX paldo PapugLinux Parabola
Pardus Parsix Parted Magic PC-BSD PCLinuxOS Pear PelicanHPC Pentoo Peppermint pfSense Phayoune Pinguy
Plamo PLD Plop Porteus Poseidon pQui Privatix Proxmox PUIAS Puppy Puredyne PureOS Qimo Qomo Quirky
Red Flag Red Hat Redo redWall Resulinux RIPLinuX Rocks Cluster ROSA Runtu Sabayon Sabily SalineOS
Salix SAMity Satux SchilliX Scientific Securepoint Semplice siduction Skolelinux Slackware SliTaz SME
Ser ver SmoothWall SMS Snowlinux SoL Solaris Sorcerer Source Mage STD StressLinux SuliX SuperGamer
Super OS SuperX Suriyan SUSE Swift Syllable SystemRescue T2 Tails Tango Studio TFM Thinstation Tiny
Core TinyMe Toorox Toutou Trinity Trisquel trixbox Tuquito Turbolinux TurnKey UberStudent Ubuntu Ubuntu
DP Ubuntu Rescue Ubuntu Studio UHU-Linux Ulteo Ultimate Unity Untangle UPR Userful UTUTO Vector
VENENUX Vine Vinux VLOS VMKnoppix VortexBox Vyatta wattOS Webconverger Wifislax xPUD Xubuntu
Yellow Dog Ylmf Yoper Zentyal Zenwalk Zeroshell ZevenOS Zorin

See on http://distrowatch.com/

Debian
Fedora


Debian


Fedora


Nota

A quei tempi il progetto si chiamava solo
“trash” (come il comando)


Reviewer

“ The name of this package is also a bit
too generic, though not that much.

Saturday, March 24, 12
32 @andreafrancia
”
#trash-cli
32

Reviewer

“ Could upstream change it to be less
generic?

https:/

33
”
/bugzilla.redhat.com/show_bug.cgi?id=448122#c1
@andreafrancia #trash-cli
33

Developer

“ Ok I’ll change to trash-cli.

34 @andreafrancia
”
#trash-cli
34

Reviewer

“ [Ok...but...] The name of the
command should also be trash-
cli.

https:/
35
”
@andreafrancia #trash-cli
35

Developer

“ The name of the main command is
'trash' without "-cli".

36 @andreafrancia
”
#trash-cli
36

Developer

“
The command is used is this way:
$ trash this-file
That means: "trash this-file in the
trashcan", there is no reason to append the
"-cli" suffix to the main command.

37 @andreafrancia
”
#trash-cli
37

Developer

“ You are already using the
Command Line Interface.

38 @andreafrancia
”
#trash-cli
38

Developer

“ In my opinion each command name
should reflect what the command
does.

39 @andreafrancia
”
#trash-cli
39

Reviewer

“ As far as possible.

40 @andreafrancia
”
#trash-cli
40

Developer (and others)

“ There are other programs with
generic names already
included!!

41 @andreafrancia
”
#trash-cli
41

samba-common

net
profiles
rpcclient
testparm


Postgresql

createdb
createlang
createuser droplang
dropdb dropuser


The Player Project
Free Software tools for robot and sensor applications

$ repoquery -f /usr/bin/player
player-0:2.1.1-5.fc10.i386


Reviewer & others

“ Precedent mistakes are not a
good reason to let other
generic names enter the
distro.

https:/

http:/
October/msg00223.html
45 @andreafrancia
”

/www.redhat.com/archives/fedora-devel-list/2008-
#trash-cli
45

... after some months
and discussions ...


Developer

“ .... OK

47 @andreafrancia
”
#trash-cli
47

Command names changed

trash trash-put
list-trash
restore-trash
empty-trash


Command names changed

trash trash-put
list-trash trash-list
restore-trash trash-restore
empty-trash trash-empty


Results

Debian --> vecchi nomi
Upstream --> nomi nuovi


Adesso ...
lo includono?


No!


Il packager s’era
stufato!


Results

Debian --> vecchi nomi
Upstream --> nomi nuovi
Fedora --> niente!


La beffa ...


Dopo qualche mese ...


... un altro packager...


... ri-propone trash-
cli (con i vecchi nomi),
e ...


... un altro revisore ...


... Accetta!


Lessons Learned

Non cambiare mai il nome dei comandi
Non cedere alle pressioni dei revisori
(tanto cambiano)

More at: https://github.com/andreafrancia/trash-cli/blob/
master/docs/about-the-generic-naming-issue.txt

Acceptance Tests


Acceptance Test

È un test che verifica
una feature.


Developer Test
È un test che serve allo
sviluppatore.


Usi dei Developer Test
validare il codice
supporto al design (con TDD)
rilevare regressioni
imparare una libreria
documentare l’uso di una libreria
....


Developer Tests

A volte sono chiamati: Unit Tests


Come ho affrontato
il problema


“ Avere i test é bello...

”

“ Come li scrivo?

”

“ Developer Test --> in python

”

“ Acceptance Test --> ?????

”

“ devo testare a livello utente

”

“ l’utente usa la Bash

”

“ gli script in Bash sono facili

”

“ esiste già un framework di
test per Bash

”

shunit


“ IDEA:
li scrivo in Bash!

”

Era un buona idea?


Risultati


Bash Tests are
slooow!


Little information in
failure messages


Complex set-up


Complex test set-up (1)

•$PATH tricks


Complex test set-up (2)

•Test volume creation


Two test suites

accetance test (in bash)
developer test (python)


Lessons Learned


Test

Se sono lenti
Allora non li usi

Test

Se
allora non li usi

Test

Se
Allora li usi

Quindi

Meglio se tutti
omogenei (e.g. tutto
python)

Bash Tests?
Ok, ma pochi.


shUnit non serve a
niente
Si può fare tutto in bash


Testing with Bash


#!/bin/bash
set,-o,errexit


#!/bin/bash
set,-o,errexit,
set,-o,nounset


it_should_delete_the_argument.bash

#!/bin/bash
set,-o,errexit
set,-o,nounset

#,given,a,file,named,foo
touch,foo

#,when,I,put,the,file,in,the,trash
trash-put,foo

#,then,the,file,should,have,been,gone
test,!,-f,foo

Checking output of a
command
#,comparing,output,of,a,command

diff,<(trash-list),-,<<,EXPECTED_OUTPUT
2012-03-02,19:43:44,/Users/andrea/foo
2012-03-02,19:44:04,/Users/andrea/foo
EXPECTED_OUTPUT


Licenza


“ Quale licenza?

”

“ GPL

”

GPL v2+
This program is free software; you can
redistribute it and/or modify it under
the terms of the GNU General Public
License as published by the Free
Software Foundation; either version 2 of
the License, or (at your option) any
later version.


or (at your option) any later
version.


Lessons Learned


Licenze già fatte?

Comode ma vanno capite.


Il papiro all’inizio del file é
una rottura


Papiro della GPL
#!/usr/bin/python
# list-trash: list trashed files
#
# Copyright (C) 2007,2008 Andrea Francia Trivolzio(PV) Italy
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
# 02110-1301, USA.

from libtrash import TrashDirectory

for trashed_file in TrashDirectory.trashed_files() :
print "%s %s" % (trashed_file.deletion_date, trashed_file.path)


Esistono licenze più semplici!


DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
                    Version 2, December 2004

Copyright (C) 2004 Sam Hocevar <sam@hocevar.net>

Everyone is permitted to copy and distribute verbatim or modified
copies of this license document, and changing it is allowed as long
as the name is changed.

            DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION

  0. You just DO WHAT THE FUCK YOU WANT TO.

http://sam.zoy.org/wtfpl/

Code Hosting
Services


sourceforge.net


Lessons Learned


Lessons Learned
Il ser vizo di release é importante


Lessons Learned
Feedback barrier


Lessons Learned
Feedback barrier
Si può sempre cambiare


Lessons Learned
Feedback barrier

sf.net


Lessons Learned
Feedback barrier

sf.net google
code


Lessons Learned
Feedback barrier
bitbucket
sf.net google
code


Lessons Learned
Feedback barrier
bitbucket
sf.net google
code GitHub


Lessons Learned
Feedback barrier
bitbucket
sf.net google
code ?
GitHub


Una scelta
azzeccata: Python


Internals : TrashDir


TrashDir: dove sono
nascosti i file cestinati


How it works


Gnome
KDE

TrashDir

trash-cli
XFCE


How it works
$,trash-put,pippo.txt

~/.local/share/Trash/,,,,,,,,,,,,+---------------------------------+
,,,,info/,,,,,,,,,,,,,,,,,,,-----|,[Trash,Info],,,,,,,,,,,,,,,,,,,,|
,,,,,,,,pippo.txt.trashinfo,,,,,,|,Path=/tmp/pippo.txt,,,,,,,,,,,,,|
,,,,files/,,,,,,,,,,,,,,,,,,,,,,,|,DeletionDate=2012-02-29T00:13:54|
,,,,,,,,pippo.txt,,,,,,,,,,,,,,,,+---------------------------------+
,,,,,,,,,,,,,,,,,`.
,,,,,,,,,,,,,,,,,,,`-,original,file,moved,here


How it works
$,touch,pippo.txt;,trash-put,pippo.txt,,,,,#,again

~/.local/share/Trash/,
,,,,info/,,,,,,,,,,,,,,,,,,
,,,,,,,,pippo.txt.trashinfo
,,,,,,,,pippo_1.txt.trashinfo
,,,,files/,,,,,,,,,,,,,,,,,
,,,,,,,,pippo.txt,,,,,,,,,,
,,,,,,,,pippo_1.txt,,,,,,,,,,
,,,,,,,,pippo_2.txt,,,,,,,,,,
,,,,,,,,pippo_3.txt,,,,,,,,,,


Gnome
KDE

TrashDir

cli
XFCE

pippo.txt
pippo.txt


open(3)
#include,<sys/stat.h>,,,,,,,,,,,,,,,,,,,,,,,,,,,
#include,<fcntl.h>,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,
,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,
int,open(const,char,*path,,int,oflag,,...,);,,,,
,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,^,,,,,,,,,,,,,,
,,,,,,,,,,,,,,,O_EXCL,|,O_CREAT,-’,


os.open
import,os

fd,=,os.open(dest,,os.O_RDWR,,|,
,,,,,,,,,,,,,,,,,,,os.O_CREAT,|
,,,,,,,,,,,,,,,,,,,os.O_EXCL,,0600)
,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,
os.write(fd,,content)
os.close(fd)
logger.trashinfo_created_as(dest)

return,(dest,,trash_id)


Conclusioni


Come lo farei ora?


Beer/Pizza License


Git


GitHub


No Wiki, solo .txt nei i
sorgenti


No mailing list.


Nessuno sforzo per
l’inclusione in distribuzioni


Ma qualcuno lo usa?


Distribuzioni
Debian (e Ubuntu)
Fedora
Arch Linux
Foresight Linux
OpenSuse
... forse altri


Altri progetti

LXDE usa trash-cli come libreria

(*) LXDE: Light weight X11 Desktop Environment


http://qa.debian.org/popcon-graph.php?packages=trash-cli

Grazie
Andrea Francia
http://andreafrancia.it
andrea@andreafrancia.it

139

Grazie
Andrea Francia
http://andreafrancia.it
andrea@andreafrancia.it

Libero da settembre 2012


Tutti i miei sbagli (Errori di un wannabe Open Source Developer)

Recomendados

Recomendados

Más contenido relacionado

Más de Andrea Francia

Más de Andrea Francia (14)

Último

Último (20)

Tutti i miei sbagli (Errori di un wannabe Open Source Developer)