Return summaries from list flavors

carolynvs · carolynvs · commit 201e932fbfdf · 2016-02-09T10:28:48.000-06:00
* ListFlavors returns Flavor
* ListFlavorSummaries returns FlavorSummary
* Server has a FlavorReference
diff --git a/src/corelib/Compute/v2_1/ComputeApiBuilder.cs b/src/corelib/Compute/v2_1/ComputeApiBuilder.cs
@@ -470,33 +470,33 @@ protected ComputeApiBuilder(IServiceType serviceType, IAuthenticationProvider au
         }
 
         /// <summary />
-        public virtual async Task<T> ListFlavorsAsync<T>(CancellationToken cancellationToken = default(CancellationToken))
+        public virtual async Task<T> ListFlavorSummariesAsync<T>(CancellationToken cancellationToken = default(CancellationToken))
             where T : IEnumerable<IServiceResource>
         {
-            return await BuildListFlavorsAsync(cancellationToken)
+            return await BuildListFlavorSummariesAsync(cancellationToken)
                  .SendAsync()
                  .ReceiveJson<T>()
                  .PropogateOwnerToChildren(this);
         }
 
         /// <summary />
-        public virtual Task<PreparedRequest> BuildListFlavorsAsync(CancellationToken cancellationToken = default(CancellationToken))
+        public virtual Task<PreparedRequest> BuildListFlavorSummariesAsync(CancellationToken cancellationToken = default(CancellationToken))
         {
             return Endpoint.PrepareListResourcesRequest("flavors", cancellationToken);
         }
 
         /// <summary />
-        public virtual async Task<T> ListFlavorDetailsAsync<T>(CancellationToken cancellationToken = default(CancellationToken))
+        public virtual async Task<T> ListFlavorsAsync<T>(CancellationToken cancellationToken = default(CancellationToken))
             where T : IEnumerable<IServiceResource>
         {
-            return await BuildListFlavorDetailsAsync(cancellationToken)
+            return await BuildListFlavorsAsync(cancellationToken)
                 .SendAsync()
                 .ReceiveJson<T>()
                 .PropogateOwnerToChildren(this);
         }
 
         /// <summary />
-        public virtual Task<PreparedRequest> BuildListFlavorDetailsAsync(CancellationToken cancellationToken = default(CancellationToken))
+        public virtual Task<PreparedRequest> BuildListFlavorsAsync(CancellationToken cancellationToken = default(CancellationToken))
         {
             return Endpoint.PrepareListResourcesRequest("flavors/detail", cancellationToken);
         }
diff --git a/src/corelib/Compute/v2_1/ComputeService.cs b/src/corelib/Compute/v2_1/ComputeService.cs
@@ -195,16 +195,16 @@ public ComputeService(IAuthenticationProvider authenticationProvider, string reg
             return _computeApi.GetFlavorAsync<Flavor>(flavorId, cancellationToken);
         }
 
-        /// <inheritdoc cref="ComputeApiBuilder.ListFlavorsAsync{T}" />
-        public async Task<IEnumerable<FlavorReference>> ListFlavorsAsync(CancellationToken cancellationToken = default(CancellationToken))
+        /// <inheritdoc cref="ComputeApiBuilder.ListFlavorSummariesAsync{T}" />
+        public async Task<IEnumerable<FlavorSummary>> ListFlavorSummariesAsync(CancellationToken cancellationToken = default(CancellationToken))
         {
-            return await _computeApi.ListFlavorsAsync<FlavorReferenceCollection>(cancellationToken);
+            return await _computeApi.ListFlavorSummariesAsync<FlavorSummaryCollection>(cancellationToken);
         }
 
-        /// <inheritdoc cref="ComputeApiBuilder.ListFlavorDetailsAsync{T}" />
-        public async Task<IEnumerable<Flavor>> ListFlavorDetailsAsync(CancellationToken cancellationToken = default(CancellationToken))
+        /// <inheritdoc cref="ComputeApiBuilder.ListFlavorsAsync{T}" />
+        public async Task<IEnumerable<Flavor>> ListFlavorsAsync(CancellationToken cancellationToken = default(CancellationToken))
         {
-            return await _computeApi.ListFlavorDetailsAsync<FlavorCollection>(cancellationToken);
+            return await _computeApi.ListFlavorsAsync<FlavorCollection>(cancellationToken);
         }
 
         #endregion
diff --git a/src/corelib/Compute/v2_1/ComputeServiceExtensions.cs b/src/corelib/Compute/v2_1/ComputeServiceExtensions.cs
@@ -176,16 +176,16 @@ public static Flavor GetFlavor(this ComputeService service, Identifier flavorId)
             return service.GetFlavorAsync(flavorId).ForceSynchronous();
         }
 
-        /// <inheritdoc cref="ComputeService.ListFlavorsAsync" />
-        public static IEnumerable<FlavorReference> ListFlavors(this ComputeService service)
+        /// <inheritdoc cref="ComputeService.ListFlavorSummariesAsync" />
+        public static IEnumerable<FlavorSummary> ListFlavorSummaries(this ComputeService service)
         {
-            return service.ListFlavorsAsync().ForceSynchronous();
+            return service.ListFlavorSummariesAsync().ForceSynchronous();
         }
 
-        /// <inheritdoc cref="ComputeService.ListFlavorDetailsAsync" />
-        public static IEnumerable<Flavor> ListFlavorDetails(this ComputeService service)
+        /// <inheritdoc cref="ComputeService.ListFlavorsAsync" />
+        public static IEnumerable<Flavor> ListFlavors(this ComputeService service)
         {
-            return service.ListFlavorDetailsAsync().ForceSynchronous();
+            return service.ListFlavorsAsync().ForceSynchronous();
         }
         #endregion
 
diff --git a/src/corelib/Compute/v2_1/Flavor.cs b/src/corelib/Compute/v2_1/Flavor.cs
@@ -5,7 +5,7 @@ namespace OpenStack.Compute.v2_1
 {
     /// <summary />
     [JsonConverterWithConstructor(typeof(RootWrapperConverter), "flavor")]
-    public class Flavor : FlavorReference
+    public class Flavor : FlavorSummary
     {
         /// <summary />
         [JsonProperty("disk")]
diff --git a/src/corelib/Compute/v2_1/FlavorReference.cs b/src/corelib/Compute/v2_1/FlavorReference.cs
@@ -15,18 +15,14 @@ public class FlavorReference : IHaveExtraData, IServiceResource
         [JsonProperty("id")]
         public Identifier Id { get; set; }
 
-        /// <summary /> // In some cases, only the id is populated. Use GetFlavor if Name is null.
-        [JsonProperty("name")]
-        public string Name { get; set; }
-
         /// <summary />
         [JsonExtensionData]
         IDictionary<string, JToken> IHaveExtraData.Data { get; set; } = new Dictionary<string, JToken>();
 
         object IServiceResource.Owner { get; set; }
 
         /// <inheritdoc cref="ComputeApiBuilder.GetFlavorAsync{T}" />
-        /// <exception cref="InvalidOperationException">When the <see cref="FlavorReference"/> instance was not constructed by the <see cref="ComputeService"/>, as it is missing the appropriate internal state to execute service calls.</exception>
+        /// <exception cref="InvalidOperationException">When the <see cref="FlavorSummary"/> instance was not constructed by the <see cref="ComputeService"/>, as it is missing the appropriate internal state to execute service calls.</exception>
         public Task<Flavor> GetFlavorAsync(CancellationToken cancellationToken = default(CancellationToken))
         {
             var owner = this.GetOwnerOrThrow<ComputeApiBuilder>();
diff --git a/src/corelib/Compute/v2_1/FlavorSummary.cs b/src/corelib/Compute/v2_1/FlavorSummary.cs
@@ -0,0 +1,12 @@
+using Newtonsoft.Json;
+
+namespace OpenStack.Compute.v2_1
+{
+    /// <summary />
+    public class FlavorSummary : FlavorReference
+    {
+        /// <summary /> // In some cases, only the id is populated. Use GetFlavor if Name is null.
+        [JsonProperty("name")]
+        public string Name { get; set; }   
+    }
+}
diff --git a/src/corelib/Compute/v2_1/Serialization/FlavorCollection.cs b/src/corelib/Compute/v2_1/Serialization/FlavorCollection.cs
@@ -19,10 +19,10 @@ public class FlavorCollection<T> : ResourceCollection<T>
     }
 
     /// <summary>
-    /// Represents a collection of references to flavor resources of the <see cref="ComputeService"/>.
+    /// Represents a collection of flavor summary resources of the <see cref="ComputeService"/>.
     /// </summary>
     /// <exclude />
-    public class FlavorReferenceCollection : FlavorCollection<FlavorReference>
+    public class FlavorSummaryCollection : FlavorCollection<FlavorSummary>
     { }
 
     /// <inheritdoc cref="FlavorCollection{T}" />
diff --git a/src/corelib/OpenStack.csproj b/src/corelib/OpenStack.csproj
@@ -97,6 +97,7 @@
     <Compile Include="Compute\v2_1\Actions\StopServerRequest.cs" />
     <Compile Include="Compute\v2_1\AddressType.cs" />
     <Compile Include="Compute\v2_1\Flavor.cs" />
+    <Compile Include="Compute\v2_1\FlavorReference.cs" />
     <Compile Include="Compute\v2_1\ImageMetadataExtensions.cs" />
     <Compile Include="Compute\v2_1\ImageExtensions.cs" />
     <Compile Include="Compute\v2_1\Image.cs" />
@@ -150,7 +151,7 @@
     <Compile Include="Compute\v2_1\ServerBlockDeviceMapping.cs" />
     <Compile Include="Compute\v2_1\ServerCreateDefinition.cs" />
     <Compile Include="Compute\v2_1\DiskConfiguration.cs" />
-    <Compile Include="Compute\v2_1\FlavorReference.cs" />
+    <Compile Include="Compute\v2_1\FlavorSummary.cs" />
     <Compile Include="Compute\v2_1\ImageReference.cs" />
     <Compile Include="Compute\v2_1\KeyPairSummary.cs" />
     <Compile Include="Compute\v2_1\KeyPairDefinition.cs" />
diff --git a/src/testing/integration/Compute/v2_1/ComputeTestDataManager.cs b/src/testing/integration/Compute/v2_1/ComputeTestDataManager.cs
@@ -108,7 +108,7 @@ private async Task<Identifier> GetDefaultFlavor()
         {
             if (_defaultFlavor == null)
             {
-                var flavors = await _compute.ListFlavorsAsync();
+                var flavors = await _compute.ListFlavorSummariesAsync();
                 _defaultFlavor = flavors.First(x => x.Name == "m1.tiny").Id;
             }
             return _defaultFlavor;
diff --git a/src/testing/integration/Compute/v2_1/FlavorTests.cs b/src/testing/integration/Compute/v2_1/FlavorTests.cs
@@ -33,9 +33,9 @@ public void Dispose()
         }
         
         [Fact]
-        public async Task ListFlavorsTest()
+        public async Task ListFlavorSummariesTest()
         {
-            var results = await _compute.ListFlavorsAsync();
+            var results = await _compute.ListFlavorSummariesAsync();
 
             Assert.NotNull(results);
             Assert.All(results, result => Assert.NotNull(result.Id));
@@ -45,7 +45,7 @@ public async Task ListFlavorsTest()
         [Fact]
         public async Task GetFlavorTest()
         {
-            var results = await _compute.ListFlavorsAsync();
+            var results = await _compute.ListFlavorSummariesAsync();
 
             var flavorRef = results.FirstOrDefault(x => x.Name == "m1.tiny");
             var flavor = await flavorRef.GetFlavorAsync();
@@ -60,9 +60,9 @@ public async Task GetFlavorTest()
         }
 
         [Fact]
-        public async Task ListFlavorDetailsTest()
+        public async Task ListFlavorsTest()
         {
-            var results = await _compute.ListFlavorDetailsAsync();
+            var results = await _compute.ListFlavorsAsync();
 
             Assert.NotNull(results);
             Assert.True(results.Any());
diff --git a/src/testing/integration/Compute/v2_1/ServerTests.cs b/src/testing/integration/Compute/v2_1/ServerTests.cs
@@ -404,7 +404,7 @@ public async Task RescueServerTest()
         [Fact]
         public async Task ResizeServerTest()
         {
-            var flavors = await _compute.ListFlavorsAsync();
+            var flavors = await _compute.ListFlavorSummariesAsync();
             var small = flavors.First(f => f.Name.Contains("small")).Id;
             var medium = flavors.First(f => f.Name.Contains("medium")).Id;
 
diff --git a/src/testing/unit/Compute/v2_1/FlavorTests.cs b/src/testing/unit/Compute/v2_1/FlavorTests.cs
@@ -40,13 +40,13 @@ public void GetFlavorExtension()
             using (var httpTest = new HttpTest())
             {
                 Identifier flavorId = Guid.NewGuid();
-                httpTest.RespondWithJson(new FlavorReferenceCollection
+                httpTest.RespondWithJson(new FlavorSummaryCollection
                 {
-                    new FlavorReference {Id = flavorId}
+                    new FlavorSummary {Id = flavorId}
                 });
                 httpTest.RespondWithJson(new Flavor { Id = flavorId });
 
-                var results = _compute.ListFlavors();
+                var results = _compute.ListFlavorSummaries();
                 var flavorRef = results.First();
                 var result = flavorRef.GetFlavor();
 
@@ -56,17 +56,17 @@ public void GetFlavorExtension()
         }
 
         [Fact]
-        public void ListFlavors()
+        public void ListFlavorSummaries()
         {
             using (var httpTest = new HttpTest())
             {
                 const string flavorId = "1";
-                httpTest.RespondWithJson(new FlavorReferenceCollection
+                httpTest.RespondWithJson(new FlavorSummaryCollection
                 {
-                    Items = { new FlavorReference { Id = flavorId } }
+                    Items = { new FlavorSummary { Id = flavorId } }
                 });
 
-                var results = _compute.ListFlavors();
+                var results = _compute.ListFlavorSummaries();
 
                 httpTest.ShouldHaveCalled("*/flavors");
                 Assert.Equal(1, results.Count());
@@ -77,7 +77,7 @@ public void ListFlavors()
         }
 
         [Fact]
-        public void ListFlavorDetails()
+        public void ListFlavors()
         {
             using (var httpTest = new HttpTest())
             {
@@ -88,7 +88,7 @@ public void ListFlavorDetails()
                 });
                 httpTest.RespondWithJson(new Flavor { Id = flavorId });
 
-                var results = _compute.ListFlavorDetails();
+                var results = _compute.ListFlavors();
 
                 httpTest.ShouldHaveCalled("*/flavors");
                 Assert.Equal(1, results.Count());

Original file line number	Diff line number	Diff line change
`@@ -470,33 +470,33 @@ protected ComputeApiBuilder(IServiceType serviceType, IAuthenticationProvider au`
`470`	`470`	`}`
`471`	`471`
`472`	`472`	`/// <summary />`
`473`		`- public virtual async Task<T> ListFlavorsAsync<T>(CancellationToken cancellationToken = default(CancellationToken))`
	`473`	`+ public virtual async Task<T> ListFlavorSummariesAsync<T>(CancellationToken cancellationToken = default(CancellationToken))`
`474`	`474`	`where T : IEnumerable<IServiceResource>`
`475`	`475`	`{`
`476`		`- return await BuildListFlavorsAsync(cancellationToken)`
	`476`	`+ return await BuildListFlavorSummariesAsync(cancellationToken)`
`477`	`477`	`.SendAsync()`
`478`	`478`	`.ReceiveJson<T>()`
`479`	`479`	`.PropogateOwnerToChildren(this);`
`480`	`480`	`}`
`481`	`481`
`482`	`482`	`/// <summary />`
`483`		`- public virtual Task<PreparedRequest> BuildListFlavorsAsync(CancellationToken cancellationToken = default(CancellationToken))`
	`483`	`+ public virtual Task<PreparedRequest> BuildListFlavorSummariesAsync(CancellationToken cancellationToken = default(CancellationToken))`
`484`	`484`	`{`
`485`	`485`	`return Endpoint.PrepareListResourcesRequest("flavors", cancellationToken);`
`486`	`486`	`}`
`487`	`487`
`488`	`488`	`/// <summary />`
`489`		`- public virtual async Task<T> ListFlavorDetailsAsync<T>(CancellationToken cancellationToken = default(CancellationToken))`
	`489`	`+ public virtual async Task<T> ListFlavorsAsync<T>(CancellationToken cancellationToken = default(CancellationToken))`
`490`	`490`	`where T : IEnumerable<IServiceResource>`
`491`	`491`	`{`
`492`		`- return await BuildListFlavorDetailsAsync(cancellationToken)`
	`492`	`+ return await BuildListFlavorsAsync(cancellationToken)`
`493`	`493`	`.SendAsync()`
`494`	`494`	`.ReceiveJson<T>()`
`495`	`495`	`.PropogateOwnerToChildren(this);`
`496`	`496`	`}`
`497`	`497`
`498`	`498`	`/// <summary />`
`499`		`- public virtual Task<PreparedRequest> BuildListFlavorDetailsAsync(CancellationToken cancellationToken = default(CancellationToken))`
	`499`	`+ public virtual Task<PreparedRequest> BuildListFlavorsAsync(CancellationToken cancellationToken = default(CancellationToken))`
`500`	`500`	`{`
`501`	`501`	`return Endpoint.PrepareListResourcesRequest("flavors/detail", cancellationToken);`
`502`	`502`	`}`
Original file line number	Diff line number	Diff line change
`@@ -195,16 +195,16 @@ public ComputeService(IAuthenticationProvider authenticationProvider, string reg`
`195`	`195`	`return _computeApi.GetFlavorAsync<Flavor>(flavorId, cancellationToken);`
`196`	`196`	`}`
`197`	`197`
`198`		`- /// <inheritdoc cref="ComputeApiBuilder.ListFlavorsAsync{T}" />`
`199`		`- public async Task<IEnumerable<FlavorReference>> ListFlavorsAsync(CancellationToken cancellationToken = default(CancellationToken))`
	`198`	`+ /// <inheritdoc cref="ComputeApiBuilder.ListFlavorSummariesAsync{T}" />`
	`199`	`+ public async Task<IEnumerable<FlavorSummary>> ListFlavorSummariesAsync(CancellationToken cancellationToken = default(CancellationToken))`
`200`	`200`	`{`
`201`		`- return await _computeApi.ListFlavorsAsync<FlavorReferenceCollection>(cancellationToken);`
	`201`	`+ return await _computeApi.ListFlavorSummariesAsync<FlavorSummaryCollection>(cancellationToken);`
`202`	`202`	`}`
`203`	`203`
`204`		`- /// <inheritdoc cref="ComputeApiBuilder.ListFlavorDetailsAsync{T}" />`
`205`		`- public async Task<IEnumerable<Flavor>> ListFlavorDetailsAsync(CancellationToken cancellationToken = default(CancellationToken))`
	`204`	`+ /// <inheritdoc cref="ComputeApiBuilder.ListFlavorsAsync{T}" />`
	`205`	`+ public async Task<IEnumerable<Flavor>> ListFlavorsAsync(CancellationToken cancellationToken = default(CancellationToken))`
`206`	`206`	`{`
`207`		`- return await _computeApi.ListFlavorDetailsAsync<FlavorCollection>(cancellationToken);`
	`207`	`+ return await _computeApi.ListFlavorsAsync<FlavorCollection>(cancellationToken);`
`208`	`208`	`}`
`209`	`209`
`210`	`210`	`#endregion`
Original file line number	Diff line number	Diff line change
`@@ -176,16 +176,16 @@ public static Flavor GetFlavor(this ComputeService service, Identifier flavorId)`
`176`	`176`	`return service.GetFlavorAsync(flavorId).ForceSynchronous();`
`177`	`177`	`}`
`178`	`178`
`179`		`- /// <inheritdoc cref="ComputeService.ListFlavorsAsync" />`
`180`		`- public static IEnumerable<FlavorReference> ListFlavors(this ComputeService service)`
	`179`	`+ /// <inheritdoc cref="ComputeService.ListFlavorSummariesAsync" />`
	`180`	`+ public static IEnumerable<FlavorSummary> ListFlavorSummaries(this ComputeService service)`
`181`	`181`	`{`
`182`		`- return service.ListFlavorsAsync().ForceSynchronous();`
	`182`	`+ return service.ListFlavorSummariesAsync().ForceSynchronous();`
`183`	`183`	`}`
`184`	`184`
`185`		`- /// <inheritdoc cref="ComputeService.ListFlavorDetailsAsync" />`
`186`		`- public static IEnumerable<Flavor> ListFlavorDetails(this ComputeService service)`
	`185`	`+ /// <inheritdoc cref="ComputeService.ListFlavorsAsync" />`
	`186`	`+ public static IEnumerable<Flavor> ListFlavors(this ComputeService service)`
`187`	`187`	`{`
`188`		`- return service.ListFlavorDetailsAsync().ForceSynchronous();`
	`188`	`+ return service.ListFlavorsAsync().ForceSynchronous();`
`189`	`189`	`}`
`190`	`190`	`#endregion`
`191`	`191`
Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@ namespace OpenStack.Compute.v2_1`
`5`	`5`	`{`
`6`	`6`	`/// <summary />`
`7`	`7`	`[JsonConverterWithConstructor(typeof(RootWrapperConverter), "flavor")]`
`8`		`- public class Flavor : FlavorReference`
	`8`	`+ public class Flavor : FlavorSummary`
`9`	`9`	`{`
`10`	`10`	`/// <summary />`
`11`	`11`	`[JsonProperty("disk")]`
Original file line number	Diff line number	Diff line change
`@@ -108,7 +108,7 @@ private async Task<Identifier> GetDefaultFlavor()`
`108`	`108`	`{`
`109`	`109`	`if (_defaultFlavor == null)`
`110`	`110`	`{`
`111`		`- var flavors = await _compute.ListFlavorsAsync();`
	`111`	`+ var flavors = await _compute.ListFlavorSummariesAsync();`
`112`	`112`	`_defaultFlavor = flavors.First(x => x.Name == "m1.tiny").Id;`
`113`	`113`	`}`
`114`	`114`	`return _defaultFlavor;`
Original file line number	Diff line number	Diff line change
`@@ -33,9 +33,9 @@ public void Dispose()`
`33`	`33`	`}`
`34`	`34`
`35`	`35`	`[Fact]`
`36`		`- public async Task ListFlavorsTest()`
	`36`	`+ public async Task ListFlavorSummariesTest()`
`37`	`37`	`{`
`38`		`- var results = await _compute.ListFlavorsAsync();`
	`38`	`+ var results = await _compute.ListFlavorSummariesAsync();`
`39`	`39`
`40`	`40`	`Assert.NotNull(results);`
`41`	`41`	`Assert.All(results, result => Assert.NotNull(result.Id));`
`@@ -45,7 +45,7 @@ public async Task ListFlavorsTest()`
`45`	`45`	`[Fact]`
`46`	`46`	`public async Task GetFlavorTest()`
`47`	`47`	`{`
`48`		`- var results = await _compute.ListFlavorsAsync();`
	`48`	`+ var results = await _compute.ListFlavorSummariesAsync();`
`49`	`49`
`50`	`50`	`var flavorRef = results.FirstOrDefault(x => x.Name == "m1.tiny");`
`51`	`51`	`var flavor = await flavorRef.GetFlavorAsync();`
`@@ -60,9 +60,9 @@ public async Task GetFlavorTest()`
`60`	`60`	`}`
`61`	`61`
`62`	`62`	`[Fact]`
`63`		`- public async Task ListFlavorDetailsTest()`
	`63`	`+ public async Task ListFlavorsTest()`
`64`	`64`	`{`
`65`		`- var results = await _compute.ListFlavorDetailsAsync();`
	`65`	`+ var results = await _compute.ListFlavorsAsync();`
`66`	`66`
`67`	`67`	`Assert.NotNull(results);`
`68`	`68`	`Assert.True(results.Any());`