Merge branch 'main' into errors_warnings

Author: Andrew

CODE_OF_CONDUCT.md

@@ -0,0 +1,8 @@
+# Code of Conduct
+
+This project has adopted the [Microsoft Open Source Code of Conduct][conduct-code].
+For more information see the [Code of Conduct FAQ][conduct-FAQ] or contact [[email protected]][conduct-email] with any additional questions or comments.
+
+[conduct-code]: https://opensource.microsoft.com/codeofconduct/
+[conduct-FAQ]: https://opensource.microsoft.com/codeofconduct/faq/
+[conduct-email]: mailto:[email protected]

CONTRIBUTING.md

@@ -0,0 +1,72 @@
+# Contributing to DSC
+
+We welcome and appreciate contributions from the community.
+There are many ways to become involved with DSC:
+including filing issues,
+joining in design conversations,
+and writing and improving documentation.
+Please read the rest of this document to ensure a smooth contribution process.
+
+## Intro to Git and GitHub
+
+* Make sure you have a [GitHub account](https://github.com/signup/free).
+* Learning GitHub:
+  * GitHub Help: [Good Resources for Learning Git and GitHub][https://help.github.com/articles/good-resources-for-learning-git-and-github/]
+* [GitHub Flow Guide](https://guides.github.com/introduction/flow/):
+  step-by-step instructions of GitHub Flow
+
+## Contributing to Issues
+
+* Check if the issue you are going to file already exists in our [GitHub issues](https://github.com/powershell/DSC/).
+* If you can't find your issue already,
+  [open a new issue](https://github.com/PowerShell/DSC/issues/new/choose),
+  making sure to follow the directions as best you can.
+
+## Contributing to Documentation
+
+### Contributing to documentation related to DSC
+
+Please see the [PowerShell-Docs-DSC](https://github.com/MicrosoftDocs/PowerShell-Docs-DSC/) repository for details.
+
+### Contributing to documentation related to maintaining or contributing to the DSC project
+
+* When writing Markdown documentation, use [semantic linefeeds](https://rhodesmill.org/brandon/2012/one-sentence-per-line/).
+  In most cases, it means "one clause/idea per line".
+* Otherwise, these issues should be treated like any other issue in this repository.
+
+#### Spellchecking documentation
+
+Documentation is spellchecked. We use the
+[textlint](https://github.com/textlint/textlint/wiki/Collection-of-textlint-rule) command-line tool,
+which can be run in interactive mode to correct typos.
+
+To run the spellchecker, follow these steps:
+
+* install [Node.js](https://nodejs.org/en/) (v10 or up)
+* install [textlint](https://github.com/textlint/textlint/wiki/Collection-of-textlint-rule) by
+  `npm install -g textlint textlint-rule-terminology`
+* run `textlint --rule terminology <changedFileName>`,
+  adding `--fix` will accept all the recommendations.
+
+If you need to add a term or disable checking part of a file see the [configuration sections of the rule](https://github.com/sapegin/textlint-rule-terminology).
+
+#### Checking links in documentation
+
+Documentation is link-checked. We make use of the
+`markdown-link-check` command-line tool,
+which can be run to see if any links are dead.
+
+To run the link-checker, follow these steps:
+
+* install [Node.js](https://nodejs.org/en/) (v10 or up)
+* install `markdown-link-check` by
+  `npm install -g [email protected]`
+* run `find . \*.md -exec markdown-link-check {} \;`
+
+## Code of Conduct Enforcement
+
+Reports of abuse will be reviewed by the PS-Committee and if it has been determined that violations of the
+Code of Conduct has occurred, then a temporary ban may be imposed.
+The duration of the temporary ban will depend on the impact and/or severity of the infraction.
+This can vary from 1 day, a few days, a week, and up to 30 days.
+Repeat offenses may result in a permanent ban from the PowerShell org.

README.md

@@ -1,17 +1,63 @@
 # DSCv3
 
-[NOTICE] This repo is currently NOT accepting contributions and is public and Open Source to show progress.  Once we are at a feature complete state, we can start taking contributions.
-
-## High level design goals
-
-- Cross-platform and Open Source
-- Bring your own agent
-  - No LCM support
-  - Azure Guest Config, Azure Automanaged VM, WinGet partners as orchestration agents
-- Author resources in PowerShell or any language
-  - Need to be executable from command-line
-  - Still supporting script based and class based resources
-- Native `dsc` command removes dependency on PowerShell
-  - Able to invoke PowerShell based resources (Windows PowerShell or PowerShell 7 runtimes)
-- Move from MOF to JSON
-- End users can author configuration in YAML or JSON and apply them using `dsc` command
+> [!NOTE]
+> This repo isn't accepting code contributions. It's public and open source to show progress and
+> enable feedback. Once we're at a feature complete state, we can start taking code contributions.
+
+## What's DSCv3?
+
+DSCv3 is the latest iteration of Microsoft's Desired State Configuration platform. DSCv3 is an open
+source command line application that abstracts the management of software components declaratively
+and idempotently. DSCv3 runs on Linux, macOS, and Windows without any external dependencies.
+
+With DSCv3, you can:
+
+- Author resources to manage your systems in any language
+- Invoke individual resources
+- Create configuration documents that define the desired state of a system
+
+### Differences from PowerShell DSC
+
+DSCv3 differs from PowerShell DSC in a few important ways:
+
+- DSCv3 doesn't depend on PowerShell. You can use DSCv3 without PowerShell installed and manage
+  resources written in bash, python, C#, Go, or any other language.
+- DSCv3 doesn't include a local configuration manager. DSCv3 is invoked as a command. It doesn't
+  run as a service.
+- Non-PowerShell resources define their schemas with JSON files, not MOF files.
+- Configuration documents are defined in JSON or YAML files, not PowerShell script files.
+
+Importantly, while DSCv3 represents a major change to the DSC platform, DSCv3 is able to invoke
+PowerShell DSC Resources, including script-based and class-based DSC Resources, as they exist today. The
+configuration documents aren't compatible, but all published PowerShell DSC Resources are. You can
+use PowerShell DSC resources in DSCv3 with both Windows PowerShell and PowerShell.
+
+## Installing DSCv3
+
+To install DSC v3:
+
+1. Download the [latest release from this repository][01].
+1. Expand the release archive.
+1. Add the folder containing the expanded archive contents to the `PATH`.
+
+## Expore DSCv3
+
+If you're new to DSC or configuration management, we recommend reviewing the [documentation][02].
+
+If you're already familiar with DSC or just want to start experimenting with v3, we recommend
+reviewing the [Samples repository][03] and the accompanying [tutorial site][04].
+
+## Integrating with DSCv3
+
+DSCv3 is a platform tool that abstracts the concerns for defining and invoking resources. Higher
+order tools, like Azure Machine Configuration, Azure Automanaged VM, and WinGet are early partners
+for DSCv3 as orchestration agents.
+
+DSCv3 uses JSON schemas to define the structure of resources, configuration documents, and the
+outputs that DSCv3 returns. These schemas make it easier to integrate DSCv3 with other tools,
+because they standardize and document how to interface with DSCv3.
+
+[01]: https://github.com/PowerShell/DSC/releases/latest
+[02]: https://learn.microsoft.com/powershell/dsc/overview?view=dsc-3.0&preserve-view=true
+[03]: https://github.com/PowerShell/DSC-Samples
+[04]: https://powershell.github.io/DSC-Samples

SECURITY.md

@@ -0,0 +1,12 @@
+# Security Vulnerabilities
+
+Security issues are treated very seriously and will, by default,
+takes precedence over other considerations including usability, performance,
+etc...  Best effort will be used to mitigate side effects of a security
+change, but DSC must be secure by default.
+
+## Reporting a security vulnerability
+
+If you believe that there is a security vulnerability in DSC,
+it **must** be reported using [https://aka.ms/secure-at](https://aka.ms/secure-at) to allow for [Coordinated Vulnerability Disclosure](https://technet.microsoft.com/security/dn467923).
+**Only** file an issue, if [MSRC](https://www.microsoft.com/en-us/msrc/faqs-report-an-issue?rtc=1) has confirmed filing an issue is appropriate.

dsc_lib/src/discovery/command_discovery.rs

@@ -6,14 +6,14 @@ use crate::dscresources::dscresource::{DscResource, ImplementedAs};
 use crate::dscresources::resource_manifest::ResourceManifest;
 use crate::dscresources::command_resource::invoke_command;
 use crate::dscerror::{DscError, StreamMessage, StreamMessageType};
-use std::collections::HashMap;
+use std::collections::BTreeMap;
 use std::env;
 use std::fs::File;
 use std::io::BufReader;
 use std::path::Path;
 
 pub struct CommandDiscovery {
-    pub resources: HashMap<String, DscResource>,
+    pub resources: BTreeMap<String, DscResource>,
     provider_resources: Vec<String>,
     initialization_messages: Vec<StreamMessage>,
     initialized: bool,
@@ -22,7 +22,7 @@ pub struct CommandDiscovery {
 impl CommandDiscovery {
     pub fn new() -> CommandDiscovery {
         CommandDiscovery {
-            resources: HashMap::new(),
+            resources: BTreeMap::new(),
             provider_resources: Vec::new(),
             initialization_messages: Vec::new(),
             initialized: false,

powershellgroup/powershellgroup.resource.ps1

@@ -55,14 +55,17 @@ if ($Operation -eq 'List')
     #$m = gmo PSDesiredStateConfiguration
     #$r += @{"DebugInfo"=@{"ModuleVersion"=$m.Version.ToString();"ModulePath"=$m.Path;"PSVersion"=$PSVersionTable.PSVersion.ToString();"PSPath"=$PSHome}}
     #$r[0] | ConvertTo-Json -Compress -Depth 3
-
     foreach ($r in $DscResources)
     {
+        if ($r.ImplementedAs -eq "Binary")
+        {
+            continue
+        }
+
         $version_string = "";
         if ($r.Version) { $version_string = $r.Version.ToString() }
         $author_string = "";
         if ($r.author) { $author_string = $r.CompanyName.ToString() }
-
         $moduleName = "";
         if ($r.ModuleName) { $moduleName = $r.ModuleName }
         elseif ($r.ParentPath) { $moduleName = Split-Path $r.ParentPath | Split-Path | Split-Path -Leaf }

test_group_resource/src/main.rs

@@ -14,7 +14,7 @@ fn main() {
     match args.subcommand {
         SubCommand::List => {
             let resource1 = DscResource {
-                type_name: "TestResource1".to_string(),
+                type_name: "Test/TestResource1".to_string(),
                 version: "1.0.0".to_string(),
                 description: Some("This is a test resource.".to_string()),
                 implemented_as: ImplementedAs::Custom("TestResource".to_string()),
@@ -28,7 +28,7 @@ fn main() {
                 }).unwrap()),
             };
             let resource2 = DscResource {
-                type_name: "TestResource2".to_string(),
+                type_name: "Test/TestResource2".to_string(),
                 version: "1.0.1".to_string(),
                 description: Some("This is a test resource.".to_string()),
                 implemented_as: ImplementedAs::Custom("TestResource".to_string()),

test_group_resource/tests/provider.tests.ps1

@@ -7,12 +7,12 @@ Describe 'Resource provider tests' {
 
         $out = dsc resource list *testresource* | ConvertFrom-Json | Sort-Object -Property type
         $out.Count | Should -Be 2
-        $out[0].type | Should -BeExactly 'TestResource1'
+        $out[0].type | Should -BeExactly 'Test/TestResource1'
         $out[0].version | Should -Be '1.0.0'
         $out[0].path | Should -BeExactly 'test_resource1'
         $out[0].implementedas | Should -BeExactly 'TestResource'
         $out[0].requires | Should -BeExactly 'Test/TestGroup'
-        $out[1].type | Should -BeExactly 'TestResource2'
+        $out[1].type | Should -BeExactly 'Test/TestResource2'
         $out[1].version | Should -Be '1.0.1'
         $out[1].path | Should -BeExactly 'test_resource2'
         $out[1].implementedas | Should -BeExactly 'TestResource'