NDepend Task for NAnt…

I was recently introduced to NDepend. While I can’t say that I fully understand all the analysis that it provides yet, I really like what I have grokked. Hopefully, as I learn more it will enable me to find my weak areas and improve my overall designs. I was a little disappointed to see that it looks like no work has been done on it as a system in over a year but I figured it was worth a little bit of my time. First off, it requires a XML file be created and passed to it so that it knows what files to analyze. Functional but certainly not something I like doing by hand and absolutely not something I want to had to maintain – I already have a script to maintain…my build script. So I figured I’d throw my hat in with the “custom NAnt task” folks and give it a shot. Attached it the code for the NDependTask that I created as a result. It’s certainly not perfect since it doesn’t handle the warn suppression quite as well as the original XML file did but it’s certainly a step in the right direction. I figure with a little better knowledge of NAnt and some work I should be able to put together the last few pieces and make it feature complete but it works for now. Just thought I’d share with anyone who was looking.

My thanks to James Geurts the author of the FxCopTask since I used that code as a general guideline when writing my NDependTask.

using System.Diagnostics;
using System.IO;
using System.Text;
using System.Xml;
using NAnt.Core;
using NAnt.Core.Attributes;
using NAnt.Core.Tasks;
using NAnt.Core.Types;

namespace NAnt.Contrib.Tasks
{
    /// <summary>
    /// Analyzes .NET assemblies and generates design quality metrics in
    /// terms of extensibility, maintainability, and reusability to
    /// effectively control and manage the assembilies dependencies.
    /// </summary>
    /// <remarks>
    /// Suppression of warns per assembly is not currently supported.
    /// Suppression of specific warns is not currently supported.
    /// </remarks>
    /// <example>
    ///        <code>
    ///            <![CDATA[
    ///            <ndepend program=”tools\ndepend\ndepend.console.exe” projectName=”MyProject” outputDir=”${build.reports}” warnNotUsedType=”false” deleteConfig=”true” runReport=”true”>
    ///                <directories>
    ///                    <include name=”${build.dir}” />
    ///                </directories>
    ///                <assembilies>
    ///                    <include name=”${build.dir}\*.dll” warn=”true” />
    ///                </assembilies>
    ///                <frameworkAssembilies>
    ///                    <include name=”${build.dir}\tests.dll” />
    ///                </frameworkAssembilies>
    ///            </ndepend>
    ///            ]]>
    ///        </code>
    /// </example>
    [TaskName( “ndepend” )]
    public class NDependTask : ExternalProgramBase
    {
        #region ” Fields “

        private string m_XmlConfigName;
        private bool m_DeleteConfig;
        private string m_ProjectName;
        private string m_OutputDir;
        private bool m_RunReport;
        private DirSet m_Directories;
        private FileSet m_Assembilies;
        private FileSet m_Framework;
        private bool m_WarnNotUsedType;
        private bool m_WarnNotUsedMember;
        private bool m_WarnTypeVisibility;
        private bool m_WarnPropertiesVisibility;
        private bool m_WarnMethodsVisibility;
        private bool m_WarnConstructorsVisibility;
        private bool m_WarnFieldsVisibility;
        private bool m_WarnEventsVisbility;

        private StringBuilder m_Arguments;

        #endregion

        #region ” Properties “

        public override string ProgramArguments
        {
            get { return m_Arguments.ToString(); }
        }

        [TaskAttribute( “program”, Required=false )]
        [StringValidator( AllowEmpty=false )]
        public override string ExeName
        {
            get { return base.ExeName; }
            set { base.ExeName = value; }
        }

        [TaskAttribute( “configFile”, Required=false )]
        public string XmlConfigName
        {
            get { return m_XmlConfigName; }
            set { m_XmlConfigName = value; }
        }

        [TaskAttribute( “deleteConfig”, Required=false )]
        [BooleanValidator()]
        public bool DeleteConfig
        {
            get { return m_DeleteConfig; }
            set { m_DeleteConfig = value; }
        }

        [TaskAttribute( “projectName”, Required=true )]
        [StringValidator( AllowEmpty=false )]
        public string ProjectName
        {
            get { return m_ProjectName; }
            set { m_ProjectName = value; }
        }

        [TaskAttribute( “outputDir”, Required=false)]
        [StringValidator( AllowEmpty=false )]
        public string OutputDir
        {
            get { return m_OutputDir; }
            set { m_OutputDir = value; }
        }

        [TaskAttribute( “runReport”, Required=false)]
        [BooleanValidator()]
        public bool RunReport
        {
            get { return m_RunReport; }
            set { m_RunReport = value; }
        }

        [BuildElement( “directories”) ]
        public DirSet Directories
        {
            get { return m_Directories; }
            set { m_Directories = value; }
        }

        [BuildElement( “assembilies”)]
        public FileSet Assembilies
        {
            get { return m_Assembilies; }
            set { m_Assembilies = value; }
        }

        [BuildElement( “frameworkAssembilies”)]
        public FileSet Framework
        {
            get { return m_Framework; }
            set { m_Framework = value; }
        }

        [TaskAttribute( “warnNotUsedType”, Required=false )]
        [BooleanValidator()]
        public bool WarnNotUsedType
        {
            get { return m_WarnNotUsedType; }
            set { m_WarnNotUsedType = value; }
        }

        [TaskAttribute( “warnNotUsedMember”, Required=false )]
        [BooleanValidator()]
        public bool WarnNotUsedMember
        {
            get { return m_WarnNotUsedMember; }
            set { m_WarnNotUsedMember = value; }
        }

        [TaskAttribute( “warnTypeVisibility”, Required=false )]
        [BooleanValidator()]
        public bool WarnTypeVisibility
        {
            get { return m_WarnTypeVisibility; }
            set { m_WarnTypeVisibility = value; }
        }

        [TaskAttribute( “warnPropertiesVisibility”, Required=false )]
        [BooleanValidator()]
        public bool WarnPropertiesVisibility
        {
            get { return m_WarnPropertiesVisibility; }
            set { m_WarnPropertiesVisibility = value; }
        }

        [TaskAttribute( “warnMethodsVisibility”, Required=false )]
        [BooleanValidator()]
        public bool WarnMethodsVisibility
        {
            get { return m_WarnMethodsVisibility; }
            set { m_WarnMethodsVisibility = value; }
        }

        [TaskAttribute( “warnConstructorsVisibility”, Required=false )]
        [BooleanValidator()]
        public bool WarnConstructorsVisibility
        {
            get { return m_WarnConstructorsVisibility; }
            set { m_WarnConstructorsVisibility = value; }
        }

        [TaskAttribute( “warnFieldsVisibility”, Required=false )]
        [BooleanValidator()]
        public bool WarnFieldsVisibility
        {
            get { return m_WarnFieldsVisibility; }
            set { m_WarnFieldsVisibility = value; }
        }

        [TaskAttribute( “warnEventsVisbility”, Required=false )]
        [BooleanValidator()]
        public bool WarnEventsVisbility
        {
            get { return m_WarnEventsVisbility; }
            set { m_WarnEventsVisbility = value; }
        }

        #endregion

        #region ” Constructors “

        /// <summary>
        /// Creates a new <see cref=”NDependTask” /> instance.
        /// </summary>
        public NDependTask()
        {
            m_Arguments = new StringBuilder();
            m_Directories = new DirSet();
            m_Assembilies = new FileSet();
            m_Framework = new FileSet();

            // Default values.
            ExeName = “ndepend.console.exe”;
            m_XmlConfigName = “ndepend.xml”;
            m_WarnConstructorsVisibility = true;
            m_WarnEventsVisbility = true;
            m_WarnFieldsVisibility = true;
            m_WarnMethodsVisibility = true;
            m_WarnNotUsedMember = true;
            m_WarnNotUsedType = true;
            m_WarnPropertiesVisibility = true;
            m_WarnTypeVisibility = true;
        }

        #endregion

        #region ” Methods “

        /// <summary>
        /// Performs logic before the external process is started
        /// </summary>
        /// <param name=”process”>Process.</param>
        protected override void PrepareProcess( Process process )
        {
            BuildConfig();
            BuildArguments();

            Log( Level.Verbose, “Working directory: {0}”, process.StartInfo.WorkingDirectory );
            Log( Level.Verbose, “Arguments: {0}”, ProgramArguments );

            base.PrepareProcess( process );
        }

        protected override Process StartProcess()
        {
            Process process = base.StartProcess ();
            process.Exited += new System.EventHandler(process_Exited);
            return process;
        }

        /// <summary>
        /// Removes generated config file after process has run.
        /// </summary>
        /// <param name=”sender”></param>
        /// <param name=”e”></param>
        private void process_Exited(object sender, System.EventArgs e)
        {
            string filename = GetConfigFilename();
            if ( File.Exists( filename ) && m_DeleteConfig )
            {
                Log( Level.Verbose, “Deleting config file.” );
                File.Delete( GetConfigFilename() );
            }
        }

        /// <summary>
        /// Concatenates variables for complete filename.
        /// </summary>
        /// <returns>Configuration filename</returns>
        private string GetConfigFilename()
        {
            if ( m_OutputDir.Length > 0 )
            {
                if ( !Directory.Exists(m_OutputDir) )
                {
                    Directory.CreateDirectory( m_OutputDir );
                }
                return Path.Combine( m_OutputDir, m_XmlConfigName );
            }
            else
            {
                return m_XmlConfigName;
            }
        }

        /// <summary>
        /// Build the arguments to pass to the executable.
        /// </summary>
        private void BuildArguments()
        {
            m_Arguments.Append( GetConfigFilename() );

            if ( m_RunReport )
            {
                m_Arguments.Append( ” /ViewReport” );
            }
        }

        /// <summary>
        /// Build the Xml config file to pass to the executable.
        /// </summary>
        private void BuildConfig()
        {
            XmlDocument config = new XmlDocument();
            // Not sure why this line is giving me an error.
//            config.AppendChild(config.CreateProcessingInstruction( “1.0”, “” ));
            XmlElement element = config.CreateElement( “NDepend” );
            XmlAttribute attribute = config.CreateAttribute( “AppName” );
            attribute.Value = m_ProjectName;
            element.Attributes.Append( attribute );
            XmlNode root = config.AppendChild( element );
           
            XmlNode node = root.AppendChild( config.CreateElement( “Dirs” ) );
            foreach( string directory in m_Directories.Includes )
            {
                element = config.CreateElement( “Dir” );
                element.InnerText = directory;
                node.AppendChild( element );
            }

            node = root.AppendChild( config.CreateElement( “Assemblies” ) );
            foreach( string file in m_Assembilies.Includes )
            {
                string assemblyName = file;
                if ( file.EndsWith( “.dll” ))
                {
                    assemblyName = file.Substring(0, file.LastIndexOf( ‘.’ ));
                }
                element = config.CreateElement( “Name” );
                element.InnerText = assemblyName;
                node.AppendChild( element );
            }

            node = root.AppendChild( config.CreateElement( “FrameworkAssemblies” ) );
            foreach( string file in m_Framework.Includes )
            {
                string assemblyName = file;
                if ( file.EndsWith( “.dll” ))
                {
                    assemblyName = file.Substring(0, file.LastIndexOf( ‘.’ ));
                }
                element = config.CreateElement( “Name” );
                element.InnerText = assemblyName;
                node.AppendChild( element );
            }

            node = root.AppendChild( config.CreateElement( “WarnFilter” ) );

            if ( !m_WarnNotUsedType )
            {
                attribute = config.CreateAttribute( “warnNotUsedType” );
                attribute.Value = “false”;
                node.Attributes.Append( attribute );
            }

            if ( !m_WarnNotUsedMember )
            {
                attribute = config.CreateAttribute( “warnNotUsedMember” );
                attribute.Value = “false”;
                node.Attributes.Append( attribute );
            }

            if ( !m_WarnTypeVisibility )
            {
                attribute = config.CreateAttribute( “warnTypeVisibility” );
                attribute.Value = “false”;
                node.Attributes.Append( attribute );
            }

            if ( !m_WarnPropertiesVisibility )
            {
                attribute = config.CreateAttribute( “warnPropertiesVisibility” );
                attribute.Value = “false”;
                node.Attributes.Append( attribute );
            }

            if ( !m_WarnMethodsVisibility )
            {
                attribute = config.CreateAttribute( “warnMethodsVisibility” );
                attribute.Value = “false”;
                node.Attributes.Append( attribute );
            }

            if ( !m_WarnConstructorsVisibility )
            {
                attribute = config.CreateAttribute( “warnConstructorsVisibility” );
                attribute.Value = “false”;
                node.Attributes.Append( attribute );
            }

            if ( !m_WarnFieldsVisibility )
            {
                attribute = config.CreateAttribute( “warnFieldsVisibility” );
                attribute.Value = “false”;
                node.Attributes.Append( attribute );
            }

            if ( !m_WarnEventsVisbility )
            {
                attribute = config.CreateAttribute( “warnEventsVisbility” );
                attribute.Value = “false”;
                node.Attributes.Append( attribute );
            }

            if ( node.Attributes.Count == 0 )
            {
                root.RemoveChild( node );
            }

            config.Save( GetConfigFilename() );
        }

        #endregion

    } // end class

} // end namespace

Advertisements

3 Responses to NDepend Task for NAnt…

  1. Trevor Brierly says:

    Thanks for posting this, it was quite helpful. I did run into a few bugs which threw me for a loop for a while, here is some fixed(?) code:
    (this should be inserted into the BuildConfig method, where it builds the names of the assemblies to pass into NDepend, about line 339
    ============================
    //BEGIN CODE
    // foreach( string file in m_Assemblies.Includes )
    foreach( string file in Assemblies.FileNames )
    {
    string assemblyName = file;
    int lastSlash = file.LastIndexOf(“\\”);
    if ( file.EndsWith( “.dll” ))
    {
    //assemblyName = file.Substring(0, file.LastIndexOf( “.” ));
    assemblyName = file.Substring( ( lastSlash + 1 ), ( file.LastIndexOf( “.” ) – lastSlash – 1 ) );
    }
    else
    {
    assemblyName = file.Substring( ( lastSlash + 1 ), ( file.Length – lastSlash ) );
    }
    element = config.CreateElement( “Name” );
    element.InnerText = assemblyName;
    node.AppendChild( element );
    }
    //END CODE HERE
    ============================
    Insert this

  2. David O'Hara says:

    Trevor,

    Thanks for reminding me – I had changed this in my code but had never updated the code in the post. I’ve actually done a few things, including reformatting so that they might actually accept it in the NAntContrib project, so I guess I should put the new code up on the post.

  3. Alan Bahm says:

    David,

    Thank you for publishing this task! From your reply to Trevor’s comment I take it that you have a later version of the code – can you post it?

%d bloggers like this: