Skip to content

Commit c281b40

Browse files
zac-schuttzac-schutt
committed
Update test code snippet location and documentation
1 parent 4d9590e commit c281b40

File tree

3 files changed

+150
-153
lines changed

3 files changed

+150
-153
lines changed

‎.vscode/ShopifySharp.code-snippets

+149
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,149 @@
1+
{
2+
"Setup ShopifySharp Test": {
3+
"prefix": "test-shopifysharp",
4+
"body": [
5+
"using System;",
6+
"using System.Collections.Generic;",
7+
"using System.Linq;",
8+
"using System.Net;",
9+
"using System.Threading.Tasks;",
10+
"using Xunit;",
11+
"",
12+
"namespace ShopifySharp.Tests",
13+
"{",
14+
"\t[Trait(\"Category\", \"$1\")]",
15+
"\tpublic class $1_Tests : IClassFixture<$1_Tests_Fixture>",
16+
"\t{",
17+
"\t\tprivate $1_Tests_Fixture Fixture { get; }",
18+
"",
19+
"\t\tpublic $1_Tests($1_Tests_Fixture fixture)",
20+
"\t\t{",
21+
"\t\t\tthis.Fixture = fixture;",
22+
"\t\t}",
23+
"",
24+
"\t\t[Fact]",
25+
"\t\tpublic async Task Counts_$1s()",
26+
"\t\t{",
27+
"\t\t\tvar count = await Fixture.Service.CountAsync();",
28+
"",
29+
"\t\t\tAssert.True(count > 0);",
30+
"\t\t}",
31+
"",
32+
"\t\t[Fact]",
33+
"\t\tpublic async Task Lists_$1s()",
34+
"\t\t{",
35+
"\t\t\tvar list = await Fixture.Service.ListAsync();",
36+
"",
37+
"\t\t\tAssert.True(list.Count() > 0);",
38+
"\t\t}",
39+
"",
40+
"\t\t[Fact]",
41+
"\t\tpublic async Task Deletes_$1s()",
42+
"\t\t{",
43+
"\t\t\tvar created = await Fixture.Create(true);",
44+
"\t\t\tbool threw = false;",
45+
"",
46+
"\t\t\ttry",
47+
"\t\t\t{",
48+
"\t\t\t\tawait Fixture.Service.DeleteAsync(created.Id.Value);",
49+
"\t\t\t}",
50+
"\t\t\tcatch (ShopifyException ex)",
51+
"\t\t\t{",
52+
"\t\t\t\tConsole.WriteLine($\"{nameof(Deletes_$1s)} failed. {ex.Message}\");",
53+
"",
54+
"\t\t\t\tthrew = true;",
55+
"\t\t\t}",
56+
"",
57+
"\t\t\tAssert.False(threw);",
58+
"\t\t}",
59+
"",
60+
"\t\t[Fact]",
61+
"\t\tpublic async Task Gets_$1s()",
62+
"\t\t{",
63+
"\t\t\tvar obj = await Fixture.Service.GetAsync(Fixture.Created.First().Id.Value);",
64+
"",
65+
"\t\t\tAssert.NotNull(obj);",
66+
"\t\t\tAssert.True(obj.Id.HasValue);",
67+
"\t\t}",
68+
"",
69+
"\t\t[Fact]",
70+
"\t\tpublic async Task Creates_$1s()",
71+
"\t\t{",
72+
"\t\t\tvar obj = await Fixture.Create();",
73+
"",
74+
"\t\t\tAssert.NotNull(obj);",
75+
"\t\t\tAssert.True(obj.Id.HasValue);",
76+
"\t\t}",
77+
"",
78+
"\t\t[Fact]",
79+
"\t\tpublic async Task Updates_$1s()",
80+
"\t\t{",
81+
"\t\t\tstring newValue = \"New Value\";",
82+
"\t\t\tvar created = await Fixture.Create();",
83+
"\t\t\tlong id = created.Id.Value;",
84+
"\t\t\t",
85+
"\t\t\tcreated.Value = newValue;",
86+
"\t\t\tcreated.Id = null;",
87+
"\t\t\t",
88+
"\t\t\tvar updated = await Fixture.Service.UpdateAsync(id, created);",
89+
"",
90+
"\t\t\t// Reset the id so the Fixture can properly delete this object.",
91+
"\t\t\tcreated.Id = id;",
92+
"",
93+
"\t\t\tAssert.Equal(newValue, updated.Value); ",
94+
"\t\t}",
95+
"\t}",
96+
"",
97+
"\tpublic class $1_Tests_Fixture: IAsyncLifetime",
98+
"\t{",
99+
"\t\tpublic $1Service Service => new $1Service(Utils.MyShopifyUrl, Utils.AccessToken);",
100+
"",
101+
"\t\tpublic List<$1> Created { get; } = new List<$1>();",
102+
"",
103+
"\t\tpublic async Task InitializeAsync()",
104+
"\t\t{",
105+
"\t\t\t// Create one for count, list, get, etc. tests.",
106+
"\t\t\tawait Create();",
107+
"\t\t}",
108+
"",
109+
"\t\tpublic async Task DisposeAsync()",
110+
"\t\t{",
111+
"\t\t\tforeach (var obj in Created)",
112+
"\t\t\t{",
113+
"\t\t\t\ttry",
114+
"\t\t\t\t{",
115+
"\t\t\t\t\tawait Service.DeleteAsync(obj.Id.Value);",
116+
"\t\t\t\t}",
117+
"\t\t\t\tcatch (ShopifyException ex)",
118+
"\t\t\t\t{",
119+
"\t\t\t\t\tif (ex.HttpStatusCode != HttpStatusCode.NotFound)",
120+
"\t\t\t\t\t{",
121+
"\t\t\t\t\t\tConsole.WriteLine($\"Failed to delete created $1 with id {obj.Id.Value}. {ex.Message}\");",
122+
"\t\t\t\t\t}",
123+
"\t\t\t\t}",
124+
"\t\t\t}",
125+
"\t\t}",
126+
"",
127+
"\t\t/// <summary>",
128+
"\t\t/// Convenience function for running tests. Creates an object and automatically adds it to the queue for deleting after tests finish.",
129+
"\t\t/// </summary>",
130+
"\t\tpublic async Task<$1> Create(bool skipAddToCreateList = false)",
131+
"\t\t{",
132+
"\t\t\tvar obj = await Service.CreateAsync(new $1()",
133+
"\t\t\t{",
134+
"\t\t\t\t$0",
135+
"\t\t\t});",
136+
"",
137+
"\t\t\tif (! skipAddToCreateList)",
138+
"\t\t\t{",
139+
"\t\t\t\tCreated.Add(obj);",
140+
"\t\t\t}",
141+
"",
142+
"\t\t\treturn obj;",
143+
"\t\t}",
144+
"\t}",
145+
"}"
146+
],
147+
"description": "Creates an xunit test class for ShopifySharp."
148+
}
149+
}

‎.vscode/snippets.csharp.json

-152
This file was deleted.

‎docs/contribution-guide.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ We don't reject these outright -- improvements are always welcome -- but anythin
6666

6767
ShopifySharp is uses [xUnit](https://xunit.github.io/) for tests. New tests should all follow the format of other, existing tests. You can use the [Article](https://github.com/nozzlegear/ShopifySharp/blob/master/ShopifySharp.Tests/Article_Tests.cs) test as an example.
6868

69-
If you're using VS Code, I would highly recommend that you [use the provided ShopifySharp Test snippet in the VSCode folder](https://github.com/nozzlegear/ShopifySharp/blob/master/.vscode/snippets.csharp.json). This snippet will set up a new test file for you when you type `test-shopifysharp`:
69+
If you're using VS Code, a snippet should be automatically loaded for creating tests. This snippet will set up a new test file for you when you type `test-shopifysharp`:
7070

7171
![shopifysharp-test](https://cloud.githubusercontent.com/assets/2417276/25457929/94bc71dc-2a9d-11e7-80ac-72352715504e.gif)
7272

0 commit comments

Comments
 (0)