View source for CSharp:Unit Test

=Definizione=
Gli Unit Test aiutano a testare una funzione basica.<br />
Dato un caso d'uso, lo Unit Test aiuta a verificare che la funzione dedicata allo scopo assolva alla sua missione.<br />
In sostanza alla solution su cui si vuol applicare una o più batterie di unit test, si aggiungerà un progetto di tipo "Test"; ogni sua classe avrà dei metodi aggiunti per validare il funzionamento di una funzione di una classe già esistente (di uno dei progetti della solution iniziale).<br />
Praticamente esistono dei Framework che aiutano nella stesura di UnitTest con una serie di funzionalità che consentono di testare specificatamente delle funzioni del nostro applicativo. Uno dei più semplici da installare ed usare è quello di Charlie Poole, Rob Prouse, Simone Busoli, Neil Colvin, "NUnit" ([https://www.nunit.org/index.php?p=home sito NUnit.org]).

=Preparazione=
Framework:
# rhino mochks
==Installazione NUnit==
Supponendo di non avere disponibile questo framework nel nostro Visual Studio, lo si può installare usando NuGet.<br /> ([https://www.nunit.org/index.php?p=home NUnit.org], [https://github.com/nunit/docs/wiki Wiki]).
===Usando NuGet===
[[File:NuGet_instalazione_fwk_NUnit.png|none]]
Scegliere la libreria interessata:
[[File:NuGet_instalazione_fwk_NUnit_02.png|none]]
Procedere all'installazione
[[File:NuGet_instalazione_fwk_NUnit_03.png|none]]
==Creazione del progetto di Test==
Aggiungiamo un nuovo progetto di Test alla nostra solution:
[[File:UnitTest_New_Project.png|none]]
Al progetto di test aggiungere una reference del progetto da Testare e Creare una prima classe di test.
[[File:UnitTest_New_Project_02.png|none]]
Ecco un esempio di vari UnitTest per testare una funzionalità:
[[File:UnitTest_New_Project_03.png|none]]

=Esempi=
==Da TDD==
Dopo una sessione di Test Driven Developping ([https://it.wikipedia.org/wiki/Test_driven_development TDD])<br />
<br />
Il seguente codice (Capitoli: "Funzione da testare", "Classe con Unit tests") è stato scritto in sede di una sessione di traning all''''Extreme programming''' (XP), è una esercitazione allo sviluppo '''TDD''', sviluppo guidato dal testing.<br />L'esercizio consiste nell'implementazione di una funzionalità (mi riferisco al metodo "<code>StringSum(string strCSVInput)</code>" del codice seguente) come risultato di diverse ''iterazioni'' ognuna delle quali aggiunge una caratteristica a quanto implementato nell'iterazione precedente.<br />
Ogni iterazione è etichettata con: <span style="color: #008000;">TDD ''n''</span>. Una iterazione consiste nello sviluppare un test che risponda all'implementazione di una funzionalità che via via sarà incrementa dalle iterazioni successive.<br />
Quindi se dobbiamo sviluppare una funzione, es:
<syntaxhighlight lang="csharp">
public static int StringSum(string strCSVInput)
{
     return -1;
}
</syntaxhighlight>
Indipendentemente da quanto dovremmo scrivere come implementazione della funzione "StringSum" inizieremo prima con l'implementazione del Test1 eticchettato "TDD 1".
<br />
Poichè non abbiamo ancora scritto una riga di codice della funzione da testare, la prima volta il primo test fallirà banalmente (restituisce -1 e dovrebbe restituire 0). Questo è un primo step della TDD.<br />
Poiché il test fallisce, adatteremo (al primo passo invece scriveremo codice da zero) il codice perché il test eseguito dopo sia passato positivamente.
===Funzione da testare===
Attenzione il seguente codice è il risultato dell'implementazione dei Test riportati al capitolo successivo: "''Classe con Unit tests''".
<syntaxhighlight lang="csharp">
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

namespace StringCalculator
{
    public static class StringCalculator
    {
        public static int StringSum(string strCSVInput)
        {
            int outputNr = 0;

            // Refactoring
            //// TDD 1
            //if (string.IsNullOrWhiteSpace(strCSVInput))
            //{
            //    return 0;
            //}
            //else
            if (!string.IsNullOrWhiteSpace(strCSVInput))
            {
                int partialNumberAcquired = 0;
                string errorNotNegativeNumber = string.Empty; //TDD 10
                char customDelimiter = ',';

                // TDD 8
                string patternCustomDelimiter = "//[";
                if (strCSVInput.IndexOf(patternCustomDelimiter) >= 0)
                {
                    string[] arrPattern = strCSVInput.Split('\n');
                    strCSVInput = strCSVInput.Replace(arrPattern[0] + "\n", string.Empty);
                    string paternDelimier = arrPattern[0]
                                                .Replace(patternCustomDelimiter, string.Empty)
                                                .Replace("]", string.Empty);
                    customDelimiter = paternDelimier[0];
                }

                strCSVInput = strCSVInput.Replace('\n', customDelimiter);// TDD 7


                string[] arrString = strCSVInput.Split(customDelimiter);
                foreach (string strNumber in arrString)
                {
                    partialNumberAcquired = int.Parse(strNumber);
                    if (partialNumberAcquired < 0) // TDD 9
                    {
                        // TDD 10 throw new NegativesNotAllowed("Negative number not allowed");
                        errorNotNegativeNumber += string.Format("{0} ", partialNumberAcquired);
                    }
                    outputNr += partialNumberAcquired;
                }

                if (!string.IsNullOrWhiteSpace(errorNotNegativeNumber))
                {
                    errorNotNegativeNumber = string.Format("Negative number '{0}' not expected", errorNotNegativeNumber.Trim());
                    throw new NegativesNotAllowed(errorNotNegativeNumber);
                }
            }

            return outputNr; // Refactoring

            // TDD 2
            //return 5; // Refactor
        }
    }
}

// TDD 9
public class NegativesNotAllowed : Exception
{
    public NegativesNotAllowed(string message) : base (message)
    {
    }
}
</syntaxhighlight>

===Classe con Unit tests===
I metodi in questa classe son stati, in realtà, implementati prima della stessa funzione da testare (<code>StringSum(...)</code>). Ogni metodo risponde alle richieste di una iterazione, il metodo di test si scrive per verificare quel che si dovrà implementare e questa richiesta è enunciata da un caso d'uso. <br />
Ad es all'iterazione corrispondente al ''TDD 1'', vogliamo verificare che passando una stringa vuota alla funzione "<code>StringSum</code>", si ottenga in output il numero 0 altrimenti il Test dovrà fallire.<br />
L'istruzione:
<syntaxhighlight lang="csharp">
Assert.AreEqual(outSum, 0);
</syntaxhighlight>
assolve a questo scopo.<br />
Segue il codice completo con la classe e tutti i metodi, uno per ogni iterazione TDD.
<syntaxhighlight lang="csharp">
using System;
using Microsoft.VisualStudio.TestTools.UnitTesting;
//using StringCalculator;

namespace UnitTestProject1
{
    [TestClass]
    public class UnitTest1
    {
        /// <summary>
        /// TDD 1
        /// Verifica del comportamento di StringSum(...) in presenza di una stringa vuota
        /// </summary>
        [TestMethod]
        public void TestEmptyString()
        {
            string strToTest = string.Empty;
            int outSum = StringCalculator.StringCalculator.StringSum(strToTest);

            Assert.AreEqual(outSum, 0);
        }

        /// <summary>
        /// TDD 2
        /// </summary>
        [TestMethod]
        public void TestOneNumber()
        {
            string strToTest = "5";
            int outSum = StringCalculator.StringCalculator.StringSum(strToTest);

            Assert.AreEqual(outSum, 5);
        }

        /// <summary>
        /// TDD 3
        /// </summary>
        [TestMethod]
        public void TestOneNumberDifferent()
        {
            string strToTest = "7";
            int outSum = StringCalculator.StringCalculator.StringSum(strToTest);

            Assert.AreEqual(outSum, 7);
        }

        /// <summary>
        /// TDD 4
        /// </summary>
        [TestMethod]
        public void TestTwoNumber()
        {
            string strToTest = "2,3";
            int outSum = StringCalculator.StringCalculator.StringSum(strToTest);

            Assert.AreEqual(outSum, 5);
        }

        /// <summary>
        /// TDD 5
        /// </summary>
        [TestMethod]
        public void TestTreeNumber()
        {
            string strToTest = "2,3,5";
            int outSum = StringCalculator.StringCalculator.StringSum(strToTest);

            Assert.AreEqual(outSum, 10);
        }

        /// <summary>
        /// TDD 6
        /// </summary>
        [TestMethod]
        public void TestDifferentCSVNumber_newLine()
        {
            string strToTest = "2\n3\n5";
            int outSum = StringCalculator.StringCalculator.StringSum(strToTest);

            Assert.AreEqual(outSum, 10);
        }

        /// <summary>
        /// TDD 7
        /// </summary>
        [TestMethod]
        public void TestDifferentCSVNumber_CSV()
        {
            string strToTest = "2\n3,5";
            int outSum = StringCalculator.StringCalculator.StringSum(strToTest);

            Assert.AreEqual(outSum, 10);
        }

        /// <summary>
        /// TDD 8
        /// </summary>
        [TestMethod]
        public void TestDifferentCSVNumber_CustomCSV()
        {
            string strToTest = "//[;]\n1;2;3";
            int outSum = StringCalculator.StringCalculator.StringSum(strToTest);

            Assert.AreEqual(outSum, 6);
        }

        /// <summary>
        /// TDD 9
        /// </summary>
        [TestMethod]
        public void TestDifferentCSVNumber_NoNegative()
        {
            
            try
            {
                string strToTest = "1,-2,3,4,5";
                int outSum = StringCalculator.StringCalculator.StringSum(strToTest);
            }
            catch (NegativesNotAllowed ex)
            {
                return; // Ok as expected
            }
            Assert.Fail("Exception not thrown");
        }

        /// <summary>
        /// TDD 10
        /// </summary>
        [TestMethod]
        public void TestDifferentCSVNumber_NoNegativeWithMessage()
        {
            try
            {
                string strToTest = "1,-2,3,4,-5";
                int outSum = StringCalculator.StringCalculator.StringSum(strToTest);
            }
            catch (NegativesNotAllowed ex)
            {
                if (ex.Message != string.Format("Negative number '{0}' not expected", "-2 -5"))
                {
                    Assert.Fail("Thrown message not expected");
                }
                else
                {
                    return;
                }
            }
            Assert.Fail("Exception not thrown");
        }
    }
}
</syntaxhighlight>
===Esecuzione dei test===
Dopo aver implementato un singolo UnitTest o alla fune di tutte le iterazioni è sufficiente eseguirli premendo la combinazione di tasti: CTRL + R, A   oppure:
[[File:TDD_UnitTest_Exec_01.png|none]]
Segue il risultato d'esecuzione di tutti i test, è un test negativo ovvero la funzionalità soddisfa tutte le richieste dei test, altrimenti anziché avere tutti "Passed" avremmo qualche "Fail".
[[File:TDD_UnitTest_Exec_02.png|none]]

=Mappa e Link=
----
[[C Sharp | C#]] | [[CSharp:Testing | Testing]]
----
[[Visual Studio]] | [[Programmazione]]
----
'''Parole chiave''':