DNN Community Blog

The Community Blog is a personal opinion of community members and by no means the official standpoint of DNN Corp or DNN Platform. This is a place to express personal thoughts about DNNPlatform, the community and its ecosystem. Do you have useful information that you would like to share with the DNN Community in a featured article or blog? If so, please contact .

The use of the Community Blog is covered by our Community Blog Guidelines - please read before commenting or posting.


Removing Projects and TFS Binding from Solution Files

At DotNetNuke we distribute many different packages each release including source packages for the Community and our Professional and Enterprise customers.  Internally we have an overarching solution file that contains all of the projects that we work on each day, this solution file also contains all of the unit tests.  When we distribute the source packages we distribute solution files with and without the unit tests as well as a VS2008 formatted sln file and a bunch of variations for Pro and Enterprise customers, that's actually 15 different solution files.  Once the packages are created there is also an automated build that actually compiles each of these packages to ensure we have all the right projects and references set up.

Also since we are distributing these solutions to users who do not have access to our TFS setup the TFS bindings are also removed.

All of these various sln files are created from the one solution file so that all of the internal developers only ever have to deal with one sln file. 

Ok that sets the scene.  The problem is then how to remove the various projects from the solution file such that it will open in Visual Studio and also be buildable from CCNet.  Simply removing the text that defines the project is not sufficient because that leaves the Nested Projects section in a mess.  Even though Visual Studio can open the file MSBuild dies a horrible death thus making it impossible to do automated compiles.

The custom task i wrote below process the sln files in such a way that both VS and MSBuild can parse the file and do what they need to do.

To use the task you add the following to your MSBuild file

<GenerateSolutionFiles

OriginalFile="$(PackagingFolder)\DotNetNuke_Enterprise_UnitTests.sln" 
CreatedFile="$(PackagingFolder)\DotNetNuke_Community_UnitTests_Source.sln" 
ProjectNames="@(AllSolutionsProjects); @(EEProjects); @(PEProjects); 
@(EETestProjects); DotNetNuke.Professional.HtmlPro" 
Replacements="@(CEReplacements)" 
RemoveTfsBindings="true"/>

You specify the lists of projects to remove in ProjectNames and you can also do simple text replacements where you specify the test to replace and the the replacement text lie so:

  <ItemGroup>
    <CEReplacements Include="DotNetNuke_Enterprise" />
    <CEReplacements Include="DotNetNuke_Community" />
  </ItemGroup>
 

We use this to manage the website name.

The code for the Task is below.  enjoy.

using System;
using System.Linq;
using Microsoft.Build.Utilities;

namespace DotNetNuke.MSBuild.Tasks
{
    using System.IO;

    public class GenerateSolutionFiles : Task
    {
        public string OriginalFile { get; set; }
        public string CreatedFile { get; set; }
        public string[] ProjectNames { get; set; }
        public string[] Replacements { get; set; }
        public bool RemoveTfsBindings { get; set; }

        public override bool Execute()
        {
            if (ProjectNames == null)
            {
                return true;
            }
            try
            {
                var tr = new StreamReader(OriginalFile, true);
                tr.Peek();
                var fileEncoding = tr.CurrentEncoding;
                var content = tr.ReadToEnd();
                tr.Close();
                var globalIndex = content.IndexOf("Global");
                var globalSection = content.Substring(globalIndex, content.Length - globalIndex);
                var globalSections = globalSection.Split(new string[] { "GlobalSection(" }, 
                  StringSplitOptions.RemoveEmptyEntries);
                var projectsSection = content.Substring(0, globalIndex);
                projectsSection = projectsSection.Remove(0, projectsSection.IndexOf("Project("));
                var projects = projectsSection.Split(new string[] { "Project(" }, StringSplitOptions.RemoveEmptyEntries);
                var nestedProjectsSection = string.Empty;
                if (RemoveTfsBindings)
                {
                    //Remove the TFS section.
                    content = globalSections.Where(glb => glb.Contains("TeamFoundationVersionControl")).
                      Aggregate(content, (current, glb) => current.Replace(string.Concat("GlobalSection(", glb), string.Empty));
                    content = content.Replace("SAK", string.Empty);
                }
                foreach (var glb in globalSections.Where(glb => glb.Contains("NestedProjects")))
                {
                    nestedProjectsSection = string.Concat("GlobalSection(", glb);
                }
                var nestedProjects = nestedProjectsSection.Split(new char[] { '\r', '\n', '\t', '\t' }, 
                 StringSplitOptions.RemoveEmptyEntries).ToList();
                foreach (var projectName in ProjectNames)
                {
                    foreach (var project in projects)
                    {
                        if (project.Contains("ProjectSection")) continue;
                        var projectEntry = project.Replace("EndProject", string.Empty).Replace("\"", string.Empty).
                     Replace(" ", string.Empty).Replace("\r", string.Empty).Replace("\n", string.Empty);
                        var indexFirstEquals = projectEntry.IndexOf("=") + 1;
                        projectEntry = projectEntry.Remove(0, indexFirstEquals);
                        var projectNameGuid = projectEntry.Split(',');
                        if (projectNameGuid[0] == projectName)
                        {
                            content = content.Replace(string.Concat("Project(", project), string.Empty);
                            var nestedProject = nestedProjects.FirstOrDefault(l => l.StartsWith(projectNameGuid[2]));
                            if (nestedProject != default(string))
                            {
                                nestedProjects.RemoveAll(l => l.StartsWith(projectNameGuid[2]));
                            }
                        }
                    }
                }
                var filteredNestedProjects = string.Concat(string.Join("\r\n\t\t", nestedProjects.
                    ToArray()), "\r\n\t").Replace("\tEndGlobalSection", "EndGlobalSection");
                content = content.Replace(nestedProjectsSection,filteredNestedProjects);

                if (Replacements != null)
                {
                    for (var index = 0; index <= Replacements.Length - 1; index = index + 2)
                    {
                        content = content.Replace(Replacements[index], Replacements[index + 1]);
                    }
                }

                if (CreatedFile.Contains("_VS2008"))
                {
                    //Convert a copy to VS2008
                    content = content.Replace("# Visual Studio 2010", "# Visual Studio 2008");
                    content = content.Replace("Microsoft Visual Studio Solution File, Format Version 11.00", 
                     "Microsoft Visual Studio Solution File, Format Version 10.00");
                    content = content.Replace("vbproj", "VS2008.vbproj").Replace("csproj", "VS2008.csproj");
                }

                var newSolutionFile = new StreamWriter(CreatedFile, false, fileEncoding);
                newSolutionFile.WriteLine(content);
                newSolutionFile.Close();
            }
            catch (Exception ex)
            {
                var file = new StreamWriter("F:\\Builds\\log.txt");
                file.WriteLine(ex.StackTrace);
                file.Close();
                return false;
            }
            return true;
        }
    }
}

Comments

There are currently no comments, be the first to post one.

Comment Form

Only registered users may post comments.

NewsArchives


Aderson Oliveira (15)
Alec Whittington (11)
Alex Shirley (10)
Andrew Nurse (30)
Andy Tryba (1)
Anthony Glenwright (5)
Antonio Chagoury (28)
Ash Prasad (32)
Ben Schmidt (1)
Benjamin Hermann (25)
Benoit Sarton (9)
Beth Firebaugh (12)
Bill Walker (36)
Bob Kruger (5)
Bogdan Litescu (1)
Brian Dukes (2)
Brice Snow (1)
Bruce Chapman (20)
Bryan Andrews (1)
cathal connolly (55)
Charles Nurse (163)
Chris Hammond (209)
Chris Paterra (55)
Clinton Patterson (40)
Cuong Dang (21)
Daniel Bartholomew (2)
Daniel Mettler (154)
Dave Buckner (2)
David Poindexter (4)
David Rodriguez (3)
Doug Howell (11)
Erik van Ballegoij (30)
Ernst Peter Tamminga (74)
Geoff Barlow (10)
George Alatrash (6)
Gifford Watkins (3)
Gilles Le Pigocher (3)
Ian Robinson (7)
Israel Martinez (17)
Jan Blomquist (2)
Jan Jonas (3)
Jaspreet Bhatia (1)
Jenni Merrifield (6)
Joe Brinkman (274)
John Mitchell (1)
Jon Henning (14)
Jonathan Sheely (4)
Jordan Coopersmith (1)
Joseph Craig (2)
Kan Ma (1)
Keivan Beigi (3)
Ken Grierson (10)
Kevin Schreiner (6)
Leigh Pointer (31)
Lorraine Young (60)
Malik Khan (1)
Matthias Schlomann (15)
Mauricio Márquez (5)
Michael Doxsey (7)
Michael Tobisch (3)
Michael Washington (202)
Miguel Gatmaytan (3)
Mike Horton (19)
Mitchel Sellers (28)
Nathan Rover (3)
Navin V Nagiah (14)
Néstor Sánchez (31)
Nik Kalyani (14)
Peter Donker (54)
Philip Beadle (135)
Philipp Becker (4)
Richard Dumas (22)
Robert J Collins (5)
Roger Selwyn (8)
Ruben Lopez (1)
Ryan Martinez (1)
Salar Golestanian (4)
Sanjay Mehrotra (9)
Scott McCulloch (1)
Scott S (11)
Scott Wilkinson (3)
Scott Willhite (97)
Sebastian Leupold (80)
Shaun Walker (237)
Shawn Mehaffie (17)
Stefan Cullmann (12)
Stefan Kamphuis (12)
Steve Fabian (31)
Timo Breumelhof (24)
Tony Henrich (3)
Torsten Weggen (2)
Vicenç Masanas (27)
Vincent Nguyen (3)
Vitaly Kozadayev (6)
Will Morgenweck (40)
Will Strohl (165)
William Severance (5)

Content Layout

Subscribe to DNN Digest

DNN Digest is our monthly email newsletter. It highlights news and content from around the DNN ecosystem, such as new modules and themes, messages from leadership, blog posts and notable tweets. Keep your finger on the pulse of the ecosystem by subscribing.  


Copyright 2017 by DNN Corp Terms of Use Privacy
What is Liquid Content?
Find Out
What is Liquid Content?
Find Out
What is Liquid Content?
Find Out