Added WindowsFeatureSourcePath parameter to OfficeOnlineServerSetup #237
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
… update YAML config
…tup configuration and YAML file
WalkthroughAdds a mandatory WindowsFeatureSourcePath parameter to OfficeOnlineServerSetup, introduces a WindowsFeature resource NetFx35 to install Net-Framework-Core from that Source, removes NET-Framework-Core from xWindowsFeatureSet, updates WMIPerformanceAdapter DependsOn, updates unit test config, and updates CHANGELOG. Changes
Sequence Diagram(s)sequenceDiagram
autonumber
actor Admin
participant LCM as DSC LCM
participant Config as OfficeOnlineServerSetup
participant NetFx as WindowsFeature NetFx35
participant XWF as xWindowsFeatureSet OfficeOnlineServer
participant Svc as xService WMIPerformanceAdapter
Admin->>LCM: Apply configuration
LCM->>Config: Compile with Path + WindowsFeatureSourcePath
Note over Config: Declares NetFx35, OfficeOnlineServer features, and service with DependsOn
rect rgba(220,240,255,0.4)
LCM->>NetFx: Ensure Net-Framework-Core Present\nSource = WindowsFeatureSourcePath
NetFx-->>LCM: Net-Framework-Core installed
end
LCM->>XWF: Install OfficeOnlineServer feature set\n(excludes NET-Framework-Core)
XWF-->>LCM: Features installed
rect rgba(235,255,235,0.5)
LCM->>Svc: Configure WMIPerformanceAdapter\nDependsOn: NetFx35, xWindowsFeatureSet
Svc-->>LCM: Service configured
end
LCM-->>Admin: Configuration applied
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Pre-merge checks✅ Passed checks (3 passed)
📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: CHILL Plan: Pro 📒 Files selected for processing (1)
🧰 Additional context used📓 Path-based instructions (3)**⚙️ CodeRabbit configuration file
Files:
{**/*.ps1,**/*.psm1,**/*.psd1}⚙️ CodeRabbit configuration file
Files:
source/DSCResources/**/*.psm1⚙️ CodeRabbit configuration file
Files:
🔇 Additional comments (2)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (1)
CHANGELOG.md (1)
29-30: Fix casing/formatting; optionally reclassify as "Added".Use .NET proper casing and our markdown text rules (parameters bold; resource names italic). Optionally move this bullet under an “Added” subsection for Unreleased.
-- Add `WindowsFeatureSourcePath` parameter to `OfficeOnlineServerSetup` for - installing removed feature .net Framework 3.5. +- Add **WindowsFeatureSourcePath** parameter to _OfficeOnlineServerSetup_ to + enable installing the removed .NET Framework 3.5 feature.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
CHANGELOG.md(1 hunks)source/DSCResources/OfficeOnlineServerSetup/OfficeOnlineServerSetup.schema.psm1(3 hunks)tests/Unit/DSCResources/Assets/Config/OfficeOnlineServerSetup.yml(1 hunks)
🧰 Additional context used
📓 Path-based instructions (5)
**
⚙️ CodeRabbit configuration file
**: # DSC Community GuidelinesTerminology
- Command: Public command
- Function: Private function
- Resource: DSC class-based resource
Build & Test Workflow Requirements
- Run PowerShell script files from repository root
- Setup build and test environment (once per
pwshsession):./build.ps1 -Tasks noop- Build project before running tests:
./build.ps1 -Tasks build- Always run tests in new
pwshsession:Invoke-Pester -Path @({test paths}) -Output DetailedFile Organization
- Public commands:
source/Public/{CommandName}.ps1- Private functions:
source/Private/{FunctionName}.ps1- Unit tests:
tests/Unit/{Classes|Public|Private}/{Name}.Tests.ps1- Integration tests:
tests/Integration/Commands/{CommandName}.Integration.Tests.ps1Requirements
- Follow instructions over existing code patterns
- Follow PowerShell style and test guideline instructions strictly
- Always update CHANGELOG.md Unreleased section
- Localize all strings using string keys; remove any orphaned string keys
- Check DscResource.Common before creating private functions
- Separate reusable logic into private functions
- DSC resources should always be created as class-based resources
- Add unit tests for all commands/functions/resources
- Add integration tests for all public commands and resources
Files:
tests/Unit/DSCResources/Assets/Config/OfficeOnlineServerSetup.ymlsource/DSCResources/OfficeOnlineServerSetup/OfficeOnlineServerSetup.schema.psm1CHANGELOG.md
{**/*.ps1,**/*.psm1,**/*.psd1}
⚙️ CodeRabbit configuration file
{**/*.ps1,**/*.psm1,**/*.psd1}: # PowerShell GuidelinesNaming
- Use descriptive names (3+ characters, no abbreviations)
- Functions: PascalCase with Verb-Noun format using approved verbs
- Parameters: PascalCase
- Variables: camelCase
- Keywords: lower-case
- Classes: PascalCase
- Include scope for script/global/environment variables:
$script:,$global:,$env:File naming
- Class files:
###.ClassName.ps1format (e.g.001.SqlReason.ps1,004.StartupParameters.ps1)Formatting
Indentation & Spacing
- Use 4 spaces (no tabs)
- One space around operators:
$a = 1 + 2- One space between type and variable:
[String] $name- One space between keyword and parenthesis:
if ($condition)- No spaces on empty lines
- Try to limit lines to 120 characters
Braces
- Newline before opening brace (except variable assignments)
- One newline after opening brace
- Two newlines after closing brace (one if followed by another brace or continuation)
Quotes
- Use single quotes unless variable expansion is needed:
'text'vs"text $variable"Arrays
- Single line:
@('one', 'two', 'three')- Multi-line: each element on separate line with proper indentation
- Do not use the unary comma operator (
,) in return statements to force
an arrayHashtables
- Empty:
@{}- Each property on separate line with proper indentation
- Properties: Use PascalCase
Comments
- Single line:
# Comment(capitalized, on own line)- Multi-line:
<# Comment #>format (opening and closing brackets on own line), and indent text- No commented-out code
Comment-based help
- Always add comment-based help to all functions and scripts
- Comment-based help: SYNOPSIS, DESCRIPTION (40+ chars), PARAMETER, EXAMPLE sections before function/class
- Comment-based help indentation: keywords 4 spaces, text 8 spaces
- Include examples for all parameter sets and combinations
- INPUTS: List each pipeline‑accepted type (one per line) with a 1‑line description...
Files:
source/DSCResources/OfficeOnlineServerSetup/OfficeOnlineServerSetup.schema.psm1
source/DSCResources/**/*.psm1
⚙️ CodeRabbit configuration file
source/DSCResources/**/*.psm1: # MOF-based Desired State Configuration (DSC) Resources GuidelinesRequired Functions
- Every DSC resource must define:
Get-TargetResource,Set-TargetResource,Test-TargetResource- Export using
*-TargetResourcepatternFunction Return Types
Get-TargetResource: Must return hashtable with all resource propertiesTest-TargetResource: Must return boolean ($true/$false)Set-TargetResource: Must not return anything (void)Parameter Guidelines
Get-TargetResource: Only include parameters needed to retrieve actual current state valuesGet-TargetResource: Remove non-mandatory parameters that are never usedSet-TargetResourceandTest-TargetResource: Must have identical parametersSet-TargetResourceandTest-TargetResource: Unused mandatory parameters: Add "Not used in <function_name>" to help commentRequired Elements
- Each function must include
Write-Verboseat least once
Get-TargetResource: Use verbose message starting with "Getting the current state of..."Set-TargetResource: Use verbose message starting with "Setting the desired state of..."Test-TargetResource: Use verbose message starting with "Determining the current state of..."- Use localized strings for all messages (Write-Verbose, Write-Error, etc.)
- Import localized strings using
Get-LocalizedDataat module topError Handling
- Do not use
throwfor terminating errors- Use
try/catchblocks to handle exceptions- Throw localized exceptions using the appropriate
New-*Exceptioncmdlet:
New‑InvalidDataExceptionNew-ArgumentExceptionNew-InvalidOperationException- [
New-ObjectNotFoundException](https:/...
Files:
source/DSCResources/OfficeOnlineServerSetup/OfficeOnlineServerSetup.schema.psm1
**/*.md
⚙️ CodeRabbit configuration file
**/*.md: # Markdown Style Guidelines
- Wrap lines at word boundaries when over 80 characters (except tables/code blocks)
- Use 2 spaces for indentation
- Use '1.' for all items in ordered lists (1/1/1 numbering style)
- Disable
MD013rule by adding a comment for tables/code blocks exceeding 80 characters- Empty lines required before/after code blocks and headings (except before line 1)
- Escape backslashes in file paths only (not in code blocks)
- Code blocks must specify language identifiers
Text Formatting
- Parameters: bold
- Values/literals:
inline code- Resource/module/product names: italic
- Commands/files/paths:
inline code
Files:
CHANGELOG.md
CHANGELOG.md
⚙️ CodeRabbit configuration file
CHANGELOG.md: # Changelog Guidelines
- Always update the Unreleased section in CHANGELOG.md
- Use Keep a Changelog format
- Describe notable changes briefly, ≤2 items per change type
- Reference issues using format issue #<issue_number>
- No empty lines between list items in same section
- Skip adding entry if same change already exists in Unreleased section
- No duplicate sections or items in Unreleased section
Files:
CHANGELOG.md
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: dsccommunity.CommonTasks (Build Package Module)
🔇 Additional comments (2)
source/DSCResources/OfficeOnlineServerSetup/OfficeOnlineServerSetup.schema.psm1 (1)
98-102: DependsOn addition is correct.Including NetFx35 in the service dependency is appropriate; extend it if you split 3.5 sub‑features per above.
tests/Unit/DSCResources/Assets/Config/OfficeOnlineServerSetup.yml (1)
7-7: LGTM — WindowsFeatureSourcePath present; verify other usages.tests/Unit/DSCResources/Assets/Config/OfficeOnlineServerSetup.yml:7 — WindowsFeatureSourcePath: \server\Data\sxs. The verification scan for PowerShell usages did not complete (rg file-type filter + awk syntax error); confirm all OfficeOnlineServerSetup invocations pass this now-mandatory parameter.
source/DSCResources/OfficeOnlineServerSetup/OfficeOnlineServerSetup.schema.psm1
Outdated
Show resolved
Hide resolved
source/DSCResources/OfficeOnlineServerSetup/OfficeOnlineServerSetup.schema.psm1
Show resolved
Hide resolved
…n OfficeOnlineServerSetup configuration
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Pull Request
Pull Request (PR) description
Added
Task list
build.ps1 -ResolveDependency).and comment-based help.
This change is