Merge pull request #1 from markcowl/store-fix

Store fix

Author: niander

src/Storage/custom/GetCommonParameter.cs

@@ -0,0 +1,34 @@
+using System;
+
+namespace Microsoft.Azure.PowerShell.Cmdlets.Storage.Support
+{
+
+    [System.ComponentModel.TypeConverter(typeof(KindConverter))]
+    public partial struct Kind
+    {
+        /// <summary>FIXME: Field BlobStorage is MISSING DESCRIPTION</summary>
+    }
+
+    public class KindConverter : System.Management.Automation.PSTypeConverter
+    {
+        public override bool CanConvertFrom(object sourceValue, Type destinationType)
+        {
+            return true;
+        }
+
+        public override bool CanConvertTo(object sourceValue, Type destinationType)
+        {
+            return false;
+        }
+
+        public override object ConvertFrom(object sourceValue, Type destinationType, IFormatProvider formatProvider, bool ignoreCase)
+        {
+            return Kind.CreateFrom(sourceValue);
+        }
+
+        public override object ConvertTo(object sourceValue, Type destinationType, IFormatProvider formatProvider, bool ignoreCase)
+        {
+            return default(object);
+        }
+    }
+}

src/Storage/custom/Kind.cs

@@ -0,0 +1,33 @@
+using System;
+
+namespace Microsoft.Azure.PowerShell.Cmdlets.Storage.Support
+{
+    [System.ComponentModel.TypeConverter(typeof(SkuNameConverter))]
+
+    public partial struct SkuName
+    {
+    }
+    public class SkuNameConverter : System.Management.Automation.PSTypeConverter
+    {
+        public override bool CanConvertFrom(object sourceValue, Type destinationType)
+        {
+            return true;
+        }
+
+        public override bool CanConvertTo(object sourceValue, Type destinationType)
+        {
+            return false;
+        }
+
+        public override object ConvertFrom(object sourceValue, Type destinationType, IFormatProvider formatProvider, bool ignoreCase)
+        {
+            return SkuName.CreateFrom(sourceValue);
+        }
+
+        public override object ConvertTo(object sourceValue, Type destinationType, IFormatProvider formatProvider, bool ignoreCase)
+        {
+            return default(object);
+        }
+    }
+
+}

src/Storage/custom/SkuName.cs

@@ -270,7 +270,10 @@ function New-AzStorageAccount {
     process {
         if ($PSBoundParameters.ContainsKey("AsJob")) {
             $null = $PSBoundParameters.Remove("AsJob")
-            Start-Job -ScriptBlock {param($arg) Az.Storage\New-AzStorageAccount @arg} -InitializationScript {Import-Module "C:\Users\niassis\source\repos\generating\azure-powershell\src\Storage\Az.Storage.psd1"} -ArgumentList $PSBoundParameters
+            Start-Job -ScriptBlock {
+                param($arg, $modulePath) 
+                Import-Module $modulePath
+                Az.Storage\New-AzStorageAccount @arg} -ArgumentList $PSBoundParameters, (Join-Path $PSScriptRoot "..\..\Az.Storage.psd1")
         } else {
             if ($PSBoundParameters.ContainsKey("StorageEncryption")) {
                 $null = $PSBoundParameters.Add("EncryptionKeySource", "Microsoft.Storage")

src/Storage/custom/latest-2019-04-30/New-AzStorageAccount.ps1

@@ -8,7 +8,7 @@ To build, run the `build-module.ps1` at the root of the module directory. This w
 To add cmdlets that were not generated by the REST specification, use the `custom` folder. This folder allows you to add handwritten `.ps1` and `.cs` files. Currently, we support using `.ps1` scripts as new cmdlets or as additional low-level variants (via `ParameterSet`), and `.cs` files as low-level (variants) cmdlets that the exported script cmdlets call. We do not support exporting any `.cs` (dll) cmdlets directly. To read more about custom cmdlets, look at the [readme.md](custom/readme.md) in the `custom` folder.
 
 ## Generating documentation
-To generate documentation, run the `generate-help.ps1` script. This will look at the documentation comments in the generated and custom cmdlets and types, and create `.md` files into the `docs` folder. Additionally, this pulls in any examples from the `examples` folder and adds them to the generated help markdown documents. To read more about examples, look at the [readme.md](examples/readme.md) in the `examples` folder. To read more about documentation, look at the [readme.md](docs/readme.md) in the `docs` folder.
+To generate documentation, the process is now integrated into the `build-module.ps1` script. If you don't want to run this process as part of `build-module.ps1`, you can provide the `-NoDocs` switch. If you want to run documentation generation after the build process, you may still run the `generate-help.ps1` script. Overall, the process will look at the documentation comments in the generated and custom cmdlets and types, and create `.md` files into the `docs` folder. Additionally, this pulls in any examples from the `examples` folder and adds them to the generated help markdown documents. To read more about examples, look at the [readme.md](examples/readme.md) in the `examples` folder. To read more about documentation, look at the [readme.md](docs/readme.md) in the `docs` folder.
 
 ## Testing `Az.Storage`
 To test the cmdlets, we use [Pester](https://github.com/pester/Pester). Tests scripts (`.ps1`) should be added to the `test` folder. To execute the Pester tests, run the `test-module.ps1` script. This will run all tests in `playback` mode within the `test` folder. To read more about testing cmdlets, look at the [readme.md](examples/readme.md) in the `examples` folder.
@@ -19,14 +19,16 @@ To pack `Az.Storage` for distribution, run the `pack-module.ps1` script. This wi
 ## Module Script Details
 There are multiple scripts created for performing different actions for developing `Az.Storage`.
 - `build-module.ps1`
-  - Builds the module DLL (`./bin/Az.Storage.private.dll`), creates the exported cmdlets, generates custom cmdlet test stubs, and updates `./Az.Storage.psd1` with Azure profile information.
+  - Builds the module DLL (`./bin/Az.Storage.private.dll`), creates the exported cmdlets and documentation, generates custom cmdlet test stubs and exported cmdlet example stubs, and updates `./Az.Storage.psd1` with Azure profile information.
   - **Parameters**: [`Switch` parameters]
     - `-Run`: After building, creates an isolated PowerShell session and loads `Az.Storage`.
     - `-Test`: After building, runs the `Pester` tests defined in the `test` folder.
     - `-Docs`: After building, generates the Markdown documents for the modules into the `docs` folder.
     - `-Pack`: After building, packages the module into a `.nupkg`.
     - `-Code`: After building, opens a VSCode window with the module's directory and runs (see `-Run`) the module.
     - `-Release`: Builds the module in `Release` configuration (as opposed to `Debug` configuration).
+    - `-NoDocs`: Supresses writing the documentation markdown files as part of the cmdlet exporting process.
+    - `-Debugger`: Used when attaching the debugger in Visual Studio to the PowerShell session, and running the build process without recompiling the DLL. This suppresses running the script as an isolated process.
 - `run-module.ps1`
   - Creates an isolated PowerShell session and loads `Az.Storage` into the session.
   - Same as `-Run` in `build-module.ps1`.
@@ -42,7 +44,15 @@ There are multiple scripts created for performing different actions for developi
 - `pack-module.ps1`
   - Packages the module into a `.nupkg` for distribution.
   - Same as `-Pack` in `build-module.ps1`.
+- `generate-help.ps1`
+  - Generates the Markdown documents for the modules into the `docs` folder.
+  - Same as `-Docs` in `build-module.ps1`.
+  - This process is now integrated into `build-module.ps1` automatically. To disable, use `-NoDocs` when running `build-module.ps1`.
+- `export-surface.ps1`
+  - Generates Markdown documents for both the cmdlet surface and the model (class) surface of the module.
+  - These files are placed into the `resources` folder.
+  - Used for investigating the surface of your module. These are *not* documentation for distribution.
 - `check-dependencies.ps1`
-  - Used in `run-module.ps1`, `generate-help.ps1`, and `test-module.ps1` to verify dependent modules are available to run those tasks.
+  - Used in `run-module.ps1` and `test-module.ps1` to verify dependent modules are available to run those tasks.
   - It will download local (within the module's directory structure) versions of those modules as needed.
   - This script *does not* need to be ran by-hand.

src/Storage/how-to.md

@@ -7,11 +7,11 @@ This directory contains the [Pester](https://www.powershellgallery.com/packages/
 - Committed: yes
 - Packaged: no
 
-## Details (*WIP*)
-We allow three testing modes: `live`, `record`, and `playback`.
+## Details
+We allow three testing modes: *live*, *record*, and *playback*. These can be selected using the `-Live`, `-Record`, and `-Playback` switches respectively on the `test-module.ps1` script. This script will run through any `.Tests.ps1` scripts in the `test` folder. If you choose the *record* mode, it will create a `.Recording.json` file of the REST calls between the client and server. Then, when you choose *playback* mode, it will use the `.Recording.json` file to mock the communication between server and client. The *live* mode runs the same as the *record* mode; however, it doesn't create the `.Recording.json` file.
 
 ## Purpose
 Custom cmdlets generally encompass additional functionality not described in the REST specification, or combines functionality generated from the REST spec. To validate this functionality continues to operate as intended, creating tests that can be ran and re-ran against custom cmdlets is part of the framework.
 
-## Usage (*WIP*)
-This feature is currently a **work-in-progress**. It is able to create test recordings of the HTTP pipeline. However, folder structure, file names, and processes are being implemented.
+## Usage
+To execute tests, run the `test-module.ps1`. To write tests, [this example](https://github.com/pester/Pester/blob/8b9cf4248315e44f1ac6673be149f7e0d7f10466/Examples/Planets/Get-Planet.Tests.ps1#L1) from the Pester repository is very useful for getting started.