Data Programming Course  Check-in [c44938df78]

   "source": [
    "## Controllo di versione distribuito e Code Source Management"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {
    "slideshow": {
     "slide_type": "fragment"
    }
   },
   "source": [
    "Avete mai avuto diverse copie di un file, chiamate doc_v1, doc_v2 e così via?\n",
    "\n",
    "Bene, quello è un controllo di versione manuale.\n",
    "Grazie al computer possiamo fare di meglio."
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {
    "slideshow": {
     "slide_type": "fragment"
    }
   },
   "source": [
    "Possiamo tenere traccia di tutto quello che succede, tornare indietro ad un momento qualsiasi, vedere le differenze fra due versioni successive ed anche tenere \"universi paralleli\" di versioni alternative.\n",
    "\n",
    "I programmi che permettono di farlo sono i Sistemi di Controllo di Versione."
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {
    "slideshow": {
     "slide_type": "fragment"
    }
   },
   "source": [
    "Questi sono poi affiancati da sistemi di Management del Codice Sorgente, che oltre a tenere traccia della versione permettono anche di tracciare i bug e la documentazione.\n",
    "\n",
    "**Fossil** è una semplice soluzione integrata che vi fornisce tutto questo in un unico pacchetto."
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {
    "slideshow": {
     "slide_type": "fragment"
    }
   },
   "source": [
    "È già estremamente utile per lavorare da soli, e permette di usare lo stesso strumento per collaborare, coordinando il lavoro di varie persone che lavorano allo stesso progetto, online ed offline."
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {
    "slideshow": {
     "slide_type": "slide"
    }
   },
   "source": [
    "## Introduzione a Fossil\n",
    "\n",
    "si può scaricare dal suo sito web: [Fossil-SCM](https://www.fossil-scm.org/xfer/uv/download.html).\n",
    "\n",
    "È un programma free ed open source, cross-platform e contenuto in un unico file, quindi è molto facile da spostare in giro."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 74,
   "metadata": {
    "collapsed": false,

  },
  {
   "cell_type": "code",
   "execution_count": 76,
   "metadata": {
    "collapsed": false,
    "slideshow": {
     "slide_type": "fragment"
    }
   },
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [

  },
  {
   "cell_type": "code",
   "execution_count": 77,
   "metadata": {
    "collapsed": false,
    "slideshow": {
     "slide_type": "fragment"
    }
   },
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [

  },
  {
   "cell_type": "code",
   "execution_count": 80,
   "metadata": {
    "collapsed": false,
    "slideshow": {
     "slide_type": "fragment"
    }
   },
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [

  },
  {
   "cell_type": "code",
   "execution_count": 81,
   "metadata": {
    "collapsed": false,
    "slideshow": {
     "slide_type": "fragment"
    }
   },
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [

  },
  {
   "cell_type": "code",
   "execution_count": 82,
   "metadata": {
    "collapsed": false,
    "slideshow": {
     "slide_type": "fragment"
    }
   },
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [

  },
  {
   "cell_type": "code",
   "execution_count": 84,
   "metadata": {
    "collapsed": false,
    "slideshow": {
     "slide_type": "fragment"
    }
   },
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [

  },
  {
   "cell_type": "code",
   "execution_count": 85,
   "metadata": {
    "collapsed": false,
    "slideshow": {
     "slide_type": "fragment"
    }
   },
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [

   },
   "source": [
    "### file list\n",
    "\n",
    "![file list](./immagini/interfaccia_fossil_2.png)"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {
    "slideshow": {
     "slide_type": "slide"
    }
   },
   "source": [
    "Potete creare file di documentazione stile wiki, sempre contenuti nel repository!\n",
    "\n",
    "potete inoltre usare file del repository per la documentazione, basta usare gli indirizzi relativi all'indirizzo speciale \n",
    "\n",
    "    ./doc/tip/<posizione del file nella directory del repository>"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 86,
   "metadata": {
    "collapsed": false,
    "slideshow": {
     "slide_type": "slide"

  },
  {
   "cell_type": "code",
   "execution_count": 87,
   "metadata": {
    "collapsed": false,
    "slideshow": {
     "slide_type": "fragment"
    }
   },
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [

  },
  {
   "cell_type": "code",
   "execution_count": 90,
   "metadata": {
    "collapsed": false,
    "slideshow": {
     "slide_type": "fragment"
    }
   },
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [

    "Questo significa che nel mio database esistono nello stesso momento due versioni diverse dello stesso progetto, e posso passare da un all'altra senza problemi.\n",
    "\n",
    "Un grosso vantaggio del modello di DVCS di fossil è che posso usare diverse cartelle per diversi branch, ed avere il tutto sincronizzato!"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {
    "slideshow": {
     "slide_type": "slide"
    }
   },
   "source": [
    "### un caso tipico di branching\n",
    "\n",
    "avete appena raggiunto un risultato pubblicabile con le vostre analisi, e volete prepararvi per pubblicarle.\n",
    "\n",
    "Questo significa che non altererete più il codice in modo sostanziale (volete mantenere l'integrità dei risultati), ma magari aggiusterete i grafici ed i report.\n",
    "\n",
    "Allo stesso momento, i vostri collaboratori vi chiedono di fare delle modifiche piuttosto importanti del codice.\n",
    "Come potete fare?\n",
    "\n",
    "Usando due diverse branch siete in grado di dividere il lavoro senza fare confusione, ma mantenendo tutto sempre sotto controllo (e con la possibilità di far passare i risultati da un branch all'altro con **revert**)."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 102,
   "metadata": {
    "collapsed": false,
    "slideshow": {
     "slide_type": "slide"
    }
   },
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "Usage: fossil checkout ?VERSION | --latest? ?OPTIONS?\r\n",
      "   or: fossil co ?VERSION | --latest? ?OPTIONS?\r\n",
      "\r\n",
      "Check out a version specified on the command-line.  This command\r\n",
      "will abort if there are edited files in the current checkout unless\r\n",
      "the --force option appears on the command-line.  The --keep option\r\n",
      "leaves files on disk unchanged, except the manifest and manifest.uuid\r\n",
      "files.\r\n",
      "\r\n",
      "The --latest flag can be used in place of VERSION to checkout the\r\n",
      "latest version in the repository.\r\n",
      "\r\n",
      "Options:\r\n",
      "   --force           Ignore edited files in the current checkout\r\n",
      "   --keep            Only update the manifest and manifest.uuid files\r\n",
      "   --force-missing   Force checkout even if content is missing\r\n",
      "\r\n",
      "See also: update\r\n"
     ]
    }
   ],
   "source": [
    "!fossil help checkout"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {
    "slideshow": {
     "slide_type": "slide"
    }
   },
   "source": [
    "per comodità faremo il cambio di branch nella stessa directory, ma in generale creeremmo una seconda directory, apriremmo il repository e faremmo il checkout della versione che ci interessa.\n",
    "\n",
    "In questo caso, ritorniamo allo stato iniziale del repository."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 103,
   "metadata": {
    "collapsed": true,
    "slideshow": {
     "slide_type": "fragment"
    }
   },
   "outputs": [],
   "source": [
    "!fossil checkout e17a3d4a58"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 104,
   "metadata": {
    "collapsed": true,
    "slideshow": {
     "slide_type": "fragment"
    }
   },
   "outputs": [],
   "source": [
    "ls"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {
    "slideshow": {
     "slide_type": "fragment"
    }
   },
   "source": [
    "il repository è vuoto come l'abbiamo lasciato due commit fa."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 105,
   "metadata": {
    "collapsed": false,
    "slideshow": {
     "slide_type": "slide"
    }
   },
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "Writing test.txt\n"
     ]
    }
   ],
   "source": [
    "%%writefile test.txt\n",
    "this is an alternative history"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 108,
   "metadata": {
    "collapsed": false,
    "slideshow": {
     "slide_type": "fragment"
    }
   },
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "ADDED  test.txt\r\n"
     ]
    }
   ],
   "source": [
    "!fossil add test.txt"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 109,
   "metadata": {
    "collapsed": false,
    "slideshow": {
     "slide_type": "fragment"
    }
   },
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "would fork.  \"update\" first or use --allow-fork.\r\n"
     ]
    }
   ],
   "source": [
    "!fossil commit -m \"nuova storia\""
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 110,
   "metadata": {
    "collapsed": false,
    "slideshow": {
     "slide_type": "fragment"
    }
   },
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "New_Version: 5d56786fcd0396b860365fe6ea6f01c8186818cb\n",
      "**** warning: a fork has occurred *****\n"
     ]
    }
   ],
   "source": [
    "!fossil commit --allow-fork -m \"nuova storia\""
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {
    "slideshow": {
     "slide_type": "slide"
    }
   },
   "source": [
    "### la nuova timeline\n",
    "\n",
    "![timeline with branch](./immagini/interfaccia_fossil_7.png)"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {
    "slideshow": {
     "slide_type": "slide"
    }
   },
   "source": [
    "### aggiusto le proprietà del nuovo branch\n",
    "\n",
    "![timeline with branch](./immagini/interfaccia_fossil_8.png)"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {
    "slideshow": {
     "slide_type": "slide"
    }
   },
   "source": [
    "### ecco come appare la mia timeline ora\n",
    "\n",
    "![timeline with branch](./immagini/interfaccia_fossil_9.png)\n",
    "\n",
    "notate che viene registrato anche il cambiamento di nome del branch!"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {
    "slideshow": {
     "slide_type": "slide"
    }
   },
   "source": [
    "Un'altra operazione molto comune è rinominare o eliminare un file.\n",
    "\n",
    "Un comportamento curioso di fossil è che registra il cambiamento ma non lo attua: dovete esplicitamente rinominare il file dalla linea di comando"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 128,
   "metadata": {
    "collapsed": false,
    "slideshow": {
     "slide_type": "fragment"
    }
   },
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "RENAME test.txt test2.txt\r\n"
     ]
    }
   ],
   "source": [
    "!fossil mv test.txt test2.txt"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 129,
   "metadata": {
    "collapsed": false,
    "slideshow": {
     "slide_type": "fragment"
    }
   },
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "test.txt\r\n"
     ]
    }
   ],
   "source": [
    "!ls"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 130,
   "metadata": {
    "collapsed": true,
    "slideshow": {
     "slide_type": "fragment"
    }
   },
   "outputs": [],
   "source": [
    "!mv test.txt test2.txt"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 131,
   "metadata": {
    "collapsed": false,
    "deletable": true,
    "editable": true,
    "slideshow": {
     "slide_type": "slide"
    }
   },
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "repository:   /home/enrico/lavoro/fossilexample/working_directory/../mytestrepo.fossil\n",
      "local-root:   /home/enrico/lavoro/fossilexample/working_directory/\n",
      "config-db:    /home/enrico/.fossil\n",
      "checkout:     5d56786fcd0396b860365fe6ea6f01c8186818cb 2017-02-27 21:23:41 UTC\n",
      "parent:       e17a3d4a58fef68da694289aa32334d82bde5234 2017-02-27 20:27:38 UTC\n",
      "tags:         experiment\n",
      "comment:      nuova storia (user: enrico)\n",
      "RENAMED    test2.txt\n"
     ]
    }
   ],
   "source": [
    "!fossil status"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 132,
   "metadata": {
    "collapsed": false,
    "slideshow": {
     "slide_type": "fragment"
    }
   },
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "New_Version: 5728ff85e15a79f162bb955aa4a0638967aebe0c\r\n"
     ]
    }
   ],
   "source": [
    "!fossil commit -m \"cambiato il nome del file\""
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 149,
   "metadata": {
    "collapsed": true,
    "slideshow": {
     "slide_type": "slide"
    }
   },
   "outputs": [],
   "source": [
    "!rm test2.txt"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 151,
   "metadata": {
    "collapsed": false,
    "slideshow": {
     "slide_type": "fragment"
    }
   },
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "DELETED test2.txt\r\n"
     ]
    }
   ],
   "source": [
    "!fossil rm test2.txt"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 152,
   "metadata": {
    "collapsed": false,
    "slideshow": {
     "slide_type": "fragment"
    }
   },
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "Writing test3.txt\n"
     ]
    }
   ],
   "source": [
    "%%writefile test3.txt\n",
    "crazy experiments!"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 153,
   "metadata": {
    "collapsed": false,
    "slideshow": {
     "slide_type": "fragment"
    }
   },
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "ADDED  test3.txt\r\n"
     ]
    }
   ],
   "source": [
    "!fossil add test3.txt"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 154,
   "metadata": {
    "collapsed": false,
    "slideshow": {
     "slide_type": "fragment"
    }
   },
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "New_Version: 47cc19ae1f35b62a524f2b5ddc4e45d96d6b2bc7\r\n"
     ]
    }
   ],
   "source": [
    "!fossil commit -m \"ultimo commit del branch sperimentale\""
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {
    "slideshow": {
     "slide_type": "slide"
    }
   },
   "source": [
    "Ora, visto che ci piace renderci la vita complicata, vogliamo unire i due branch.\n",
    "\n",
    "Questo può servire quando stiamo facendo delle modifiche sperimentali ad una parte della nostra analisi e non vogliamo includerlo fintanto che non siamo sicuri che stia funzionando correttamente.\n",
    "\n",
    "Per fare questo dobbiamo usare il comando **merge**, ma prima dobbiamo metterci nella linea principale che vogliamo mantenere (visto che l'altra poi sparirà) con un checkout.\n",
    "\n",
    "Questo risulta molto più facile se avete due cartelle separate.\n",
    "Se state usando la stessa, controllate due volte prima di fare il checkout!"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 155,
   "metadata": {
    "collapsed": false,
    "slideshow": {
     "slide_type": "slide"
    }
   },
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "test.txt\r\n"
     ]
    }
   ],
   "source": [
    "!fossil checkout 488479276d"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 157,
   "metadata": {
    "collapsed": false,
    "slideshow": {
     "slide_type": "fragment"
    }
   },
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "ADDED test3.txt\r\n",
      "REMINDER: this was a dry run - no files were actually changed.\r\n"
     ]
    }
   ],
   "source": [
    "!fossil merge 47cc19ae1f --dry-run"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 158,
   "metadata": {
    "collapsed": false,
    "slideshow": {
     "slide_type": "fragment"
    }
   },
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "ADDED test3.txt\r\n",
      " \"fossil undo\" is available to undo changes to the working checkout.\r\n"
     ]
    }
   ],
   "source": [
    "!fossil merge 47cc19ae1f"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 159,
   "metadata": {
    "collapsed": false,
    "slideshow": {
     "slide_type": "slide"
    }
   },
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "repository:   /home/enrico/lavoro/fossilexample/working_directory/../mytestrepo.fossil\n",
      "local-root:   /home/enrico/lavoro/fossilexample/working_directory/\n",
      "config-db:    /home/enrico/.fossil\n",
      "checkout:     488479276df60e9fd055d5dbe07ee6c37b30beb3 2017-02-27 20:56:16 UTC\n",
      "parent:       1856bb82f3515646637061c6e062c117fc646192 2017-02-27 20:42:51 UTC\n",
      "tags:         trunk\n",
      "comment:      riportato l'ordine nel repository! (user: enrico)\n",
      "ADDED_BY_MERGE test3.txt\n",
      "MERGED_WITH 47cc19ae1f35b62a524f2b5ddc4e45d96d6b2bc7\n"
     ]
    }
   ],
   "source": [
    "!fossil status"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 160,
   "metadata": {
    "collapsed": false,
    "slideshow": {
     "slide_type": "fragment"
    }
   },
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "New_Version: cb5317076a540e3c4799ff184d509de665d47ddb\r\n"
     ]
    }
   ],
   "source": [
    "!fossil commit -m \"le due storie sono finalmente unite!\""
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {
    "slideshow": {
     "slide_type": "slide"
    }
   },
   "source": [
    "### la versione post-sperimentazione\n",
    "\n",
    "![timeline with branch](./immagini/interfaccia_fossil_10.png)"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {
    "slideshow": {
     "slide_type": "fragment"
    }
   },
   "source": [
    "### full disclosure\n",
    "\n",
    "Il file che abbiamo modificato all'inizio, test.txt, dava problemi per il merge perchè creato indipendentemente nei due branch. L'unica soluzione che ho trovato è stata gestire il merge a mano, in pratica creare un nuovo file da zero ed eventualmente riempirlo con il contenuto del vecchio."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {
    "collapsed": true
   },
   "outputs": [],