Trim the line before splitting parts in HostsFile

[cdhunt]

Pull Request (PR) description

Trim the line before splitting parts in Get-HostEntry.

This Pull Request (PR) fixes the following issues

• Fixes HostsFile Get-TargetResource returns an array for HostName if there is one or more spaces at the beginning of the line #526

Task list

• Added an entry to the change log under the Unreleased section of the
  file CHANGELOG.md. Entry should say what was changed and how that
  affects users (if applicable), and reference the issue being resolved
  (if applicable).
• Resource documentation added/updated in README.md.
• Resource parameter descriptions added/updated in README.md, schema.mof
  and comment-based help.
• Comment-based help added/updated.
• Localization strings added/updated in all localization files as appropriate.
• Examples appropriately added/updated.
• Unit tests added/updated. See DSC Community Testing Guidelines.
• Integration tests added/updated (where possible). See DSC Community Testing Guidelines.
• New/changed code adheres to DSC Community Style Guidelines.

---

This change is 

[PlagueHO]

The build pipeline is failing because the pipeline files haven't been updated in sometime and using a Linux build agent (which fails). I'll update the pipeline to the latest version so that you can rebase.

[cdhunt]

@PlagueHO If you point me to an example, I can probably help.

[johlju]

Updated pipeline files has been merged thanks to @PlagueHO. This PR can be rebased.

[PlagueHO]

Sorry @cdhunt - the pipeline fix was already waiting for review (#529). But there will be other DSC resource repos that need similar updates... so if you're inclined and have the time, we're always happy to have help doing the chores 😀

I've completed:

• NetworkingDsc
• ComputerManagementDsc
• StorageDsc

PR needs review:

• DFSDsc

Still need to complete:

• xPSDesiredStateConfiguration
• ADCertificateServicesDsc
• CertificateDsc
• iSCSIDsc
• FileContentDsc
• WSManDsc
• FSRMDsc

@johlju - I'll probably sit down and do some of these tonight. Will raise issues and assign them to myself as I go.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97%. Comparing base (e8b5edc) to head (43ce5ae).

Additional details and impacted files

@@         Coverage Diff         @@
##           main   #527   +/-   ##
===================================
  Coverage    97%    97%           
===================================
  Files        28     28           
  Lines      2078   2078           
===================================
  Hits       2028   2028           
  Misses       50     50           

Files	Coverage Δ
...urce/DSCResources/DSC_HostsFile/DSC_HostsFile.psm1	97% <100%> (ø)

[PlagueHO]

Thanks for submitting @cdhunt.

Reviewed 2 of 3 files at r1, 1 of 1 files at r2, all commit messages.
Reviewable status: all files reviewed, 3 unresolved discussions (waiting on @cdhunt)

---

CHANGELOG.md line 13 at r2 (raw file):

  - Renamed NetworkingDSc to NetworkingDsc in CHANGELOG.md - fixes [Issue #513](https://github.com/dsccommunity/NetworkingDsc/issues/513).
- HostsFile
  - Fix bad return data when line contains leading spaces - fixes [Issue #526](https://github.com/dsccommunity/NetworkingDsc/issues/526)

Nit: end with full stop :D

---

tests/Unit/DSC_HostsFile.Tests.ps1 line 303 at r2 (raw file):

        Context 'When a host entry has leading spaces' {

Nit: can remove blank line :)

---

tests/Unit/DSC_HostsFile.Tests.ps1 line 324 at r2 (raw file):

                (Get-TargetResource @testParams).Ensure | Should -Be 'Present'
            }
        }

What would happen if there was whitepace at the beginning of the Hostname parameter passed in the config? Edgecase definitely. E.g.

HostsFile Bad {
HostName = ' whitespace.com'
IPAddress = '192.168.1.1'
}

Would this result in a flapping config? As Get-TargetResource would return the trimmed value, but the parameter would still have untrimmed whitespace. Maybe add a test to check this?

E.g.

        $testParams = @{
            HostName  = ' www.leadingwhitespace.com'
            IPAddress = '127.0.0.1'
            Verbose   = $true
        }

[cdhunt]

What do you think the desired/expected behavior would be? Should it support intentional whitespace or enforce an exact format? You could use File.Contents if you want custom formatting.

[cdhunt]

@PlagueHO Can you rerun the failed integration test job?

[johlju]

@PlagueHO Can you rerun the failed integration test job?

I helped with that.

[cdhunt]

I've added additional tests which I believe cover at least one edge case and better cover the scenario I'm trying to fix.

[PlagueHO]

Nice! Thank you for adding that integration test.

Reviewed 1 of 3 files at r3, 2 of 2 files at r4, all commit messages.
Reviewable status: all files reviewed, 2 unresolved discussions (waiting on @cdhunt)

---

tests/Unit/DSC_HostsFile.Tests.ps1 line 327 at r4 (raw file):

                $testParams = @{
                    HostName  = 'www.contoso.com'
                    IPAddress = '192.168.0.156'

What I was really thinking here, was if you created another unit test where the IPAddress = ' 192.168.0.156' and the current hosts was:
'# A mocked example of a host file - this line is a comment',
'',
'127.0.0.1 localhost',
'127.0.0.1 www.anotherexample.com',
" 192.168.0.156 $($testParams.HostName)",
'127.0.0.5 anotherexample.com',
''
Would the Test-TargetResource return True?

In theory this should because it's in state.

---

tests/Unit/DSC_HostsFile.Tests.ps1 line 348 at r4 (raw file):

                It 'Should return false from the test method' {
                    Test-TargetResource @testParams | Should -Be $false

Sorry, missed this - can change to Should -BeFalse

[PlagueHO]

Hi @cdhunt - just realised this one is still open. Can you check the last comments and we can merge I think.

Reviewable status: all files reviewed, 2 unresolved discussions (waiting on @cdhunt)