Privacy delle funzioni e test delle unità Haskell

Question

Come si gestisce la visibilità delle funzioni e il test delle unità in Haskell?

Se si esportano tutte le funzioni in un modulo in modo che i test delle unità possano accedervi, si rischiano altre persone che chiamano funzioni che non dovrebbero essere nell'API pubblica.

Ho pensato di utilizzare {-# LANGUAGE CPP #-} e poi che circonda le esportazioni con un #ifdef:

{-# LANGUAGE CPP #-} 

module SomeModule 
#ifndef TESTING 
(export1 
, export2 
) 
#endif 
where 

C'è un modo migliore?

Answer 1

La convenzione usuale è quello di dividere il modulo in parti pubbliche e private, cioè

module SomeModule.Internal where 

-- ... exports all private methods 

e poi l'API pubblica

module SomeModule where (export1, export2) 

import SomeModule.Internal 

Quindi è possibile importare SomeModule.Internal nei test e in altri luoghi dove la sua fondamentale per ottenere l'accesso all'implementazione interna.

L'idea è che gli utenti della vostra biblioteca mai accidentalmente chiamata API private, ma essi possono usarlo se la sanno quello che stanno facendo (debugging, ecc). Ciò aumenta notevolmente l'usabilità della tua libreria rispetto a nascondere forzatamente l'API privata.

Answer 2

Per il test, in genere si divide l'applicazione nel file di progetto cabal, tra una libreria, l'eseguibile di produzione e un eseguibile test-suite che verifica le funzioni della libreria, quindi le funzioni di asserzione vengono mantenute separate.

Per la visibilità delle funzioni esterne, i moduli della libreria sono divisi tra la sezione "moduli esposti" e la sezione "altri moduli".