Day: July 13, 2017

ในช่วงการพัฒนาของ .NET Core tooling จนถึงปัจจุบัน มี design/component หลายอย่างที่มีการเปลี่ยนแปลงในลักษณะที่ไม่ compatible กับ version ก่อนหน้า หรือยกเลิกการใช้งาน หนึ่งในนั้นก็คือ project config file ที่เริ่มต้นใช้รูปแบบ json ซึ่งอยู่ใน file ที่ชื่อ project.json แต่ปัจจุบัน เปลี่ยนมาใช้ MSBuild/csproj format

การ migration project.json ไปสู่ .csproj format ทำได้ด้วยกันสองวิธีคือ

• Visual Studio 2017
• dotnet migrate command-line tool

ทั้งสองวิธีใช้กลไกการทำงานเดียวกัน ซึ่งผลที่ได้จะเหมือนกัน

Visual Studio 2017

เปิด project โดยเปิด file .xproj ใน Visual Studio 2017 จะปรากฎ One-way upgrade dialog ขึ้นมาให้เลือก OK, Visual Studio จะทำการ migrate โดย file ที่ถูก migrate (project.json, global.json, .xproj) จะถูกย้ายไปสำรองไว้ใน folder Backup

dotnet migrate

ใช้ command-line เข้าไปที่ folder ที่เก็บ project และใช้คำสั่ง dotnet migrate ซึ่งจะทำการ migrate โดย file ที่ถูก migrate (project.json, global.json, .xproj) จะถูกย้ายไปสำรองไว้ใน folder Backup

<Project Sdk="Microsoft.NET.Sdk">
  ... 
</Project>

ข้อแตกต่างระหว่าง project.json กับ csproj format ( อยู่ในรูปแบบ XML-based ซึ่งมี root node ระบุ sdk ที่ใช้คือ Microsoft.NET.Sdk สำหรับ web project sdk ที่ใช้คือ Microsoft.NET.Sdk.Web ) มีดังนี้

Common options

****** JSON format ******
{
  "name": "MyProjectName",
  "version": "1.0.0-alpha-*",

  "authors": [ "name1", "name2" ],
  "company": "PSU",
  "language": "en-US",
  "title": "My library",
  "description": "This is my library.",
  "copyright": "PSU 3000",
  "userSecretsId": "xyz123"
}

****** csproj format ******
<PropertyGroup>
 <AssemblyName>MyProjectName</AssemblyName>
 <PackageId>MyProjectName</PackageId>
 <VersionPrefix>1.0.0</VersionPrefix>
 <VersionSuffix>alpha</VersionSuffix>

 <Authors>name1;name2</Authors>
 <Company>PSU</Company>
 <NeutralLanguage>en-US</NeutralLanguage>
 <AssemblyTitle>My library</AssemblyTitle>
 <Description>This is my library.</Description>
 <Copyright>PSU 3000</Copyright>
 <UserSecretsId>xyz123</UserSecretsId>
</PropertyGroup>

frameworks

****** JSON format ******
{
  "frameworks": {
    "netcoreapp1.0": {},
    "net451": {}
  }
}

****** csproj format ******
<PropertyGroup>
 <TargetFrameworks>netcoreapp1.0;net451</TargetFrameworks>
</PropertyGroup>

dependencies

****** JSON format ******
{
  "dependencies": {
    "NETStandard.Library": "1.6.0",
    "Microsoft.AspNetCore": "1.1.0",

    "MyOtherProject": "1.0.0-*",
    "AnotherProject": {
      "type": "project"
    }
  }
}

****** csproj format ******
<PropertyGroup>
 <NetStandardImplicitPackageVersion>1.6.0</NetStandardImplicitPackageVersion> 
</PropertyGroup>

<ItemGroup>
 <PackageReference Include="Microsoft.AspNetCore" Version="1.1.0" /> 
</ItemGroup>

<ItemGroup>
 <ProjectReference Include="..\MyOtherProject\MyOtherProject.csproj" />
 <ProjectReference Include="..\AnotherProject\AnotherProject.csproj" /> 
</ItemGroup>

tools

****** JSON format ******
{
  "tools": {
    "Microsoft.EntityFrameworkCore.Tools.DotNet": "1.0.0-*"
  }
}

****** csproj format ******
<ItemGroup>
 <DotNetCliToolReference Include="Microsoft.EntityFrameworkCore.Tools.DotNet" Version="1.0.0" /> 
</ItemGroup>

buildOptions

****** JSON format ******
{
  "buildOptions": {
    "emitEntryPoint": true
    "warningsAsErrors": true,
    "nowarn": ["CS0168", "CS0219"],
    "xmlDoc": true,
    "preserveCompilationContext": true,
    "outputName": "Different.AssemblyName",
    "debugType": "portable",
    "allowUnsafe": true,
    "define": ["TEST", "OTHERCONDITION"]
  }
}

****** csproj format ******
<PropertyGroup>
 <OutputType>Exe</OutputType>
 <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
 <NoWarn>$(NoWarn);CS0168;CS0219</NoWarn>
 <GenerateDocumentationFile>true</GenerateDocumentationFile>     
 <PreserveCompilationContext>true</PreserveCompilationContext> 
 <AssemblyName>Different.AssemblyName</AssemblyName>
 <DebugType>portable</DebugType> 
 <AllowUnsafeBlocks>true</AllowUnsafeBlocks> 
 <DefineConstants>$(DefineConstants);TEST;OTHERCONDITION</DefineConstants>
</PropertyGroup>

testRunner

****** JSON format ******
{
  "testRunner": "xunit",
  "dependencies": {
    "dotnet-test-xunit": ""
  }
}

****** csproj format ******
<ItemGroup>
 <PackageReference Include="Microsoft.NET.Test.Sdk" Version="15.0.0-*" />
 <PackageReference Include="xunit" Version="2.2.0-*" />
 <PackageReference Include="xunit.runner.visualstudio" Version="2.2.0-*" /> 
</ItemGroup>

อ้างอิง : https://docs.microsoft.com/en-us/dotnet/core/tools/project-json-to-csproj

ปัจจุบันการพัฒนาโปรแกรมในรูปแบบของ API นั้นแพร่หลายมาก เนื่องจากจะทำให้โปรแกรมยืดหยุ่น สามารถพัฒนา Interface ไปในรูปแบบที่หลากหลาย ทั้ง Desktop, Mobile โดยเฉพาะการเรียก API ผ่าน http นั้น ถือว่าค่อนข้างที่จะยืดหยุ่นกับเกือบจะทุก platform ดังนั้น การรักษาความปลอดภัยให้กับ API เหล่านี้ เป็นสิ่งที่จำเป็นและสำคัญอย่างยิ่ง

บทความนี้จะพูดถึง 2 เรื่องหลักๆ ได้แก่ การ Authentication และการ Authorization ดังนี้ครับ

Authentication

เปรียบเสมือนกับการตรวจสอบว่าใครเป็นผู้ร้องขอ (request) ซึ่งอาจจะเป็นในลักษณะของ username/password หรือเป็น API Key จากใน HTTP Request Header

ในบทความนี้จะขอข้ามการพูดถึงการ authentication ด้วย username/password เพราะเชื่อว่าสามารถทำกันได้อยู่แล้ว ไม่ว่าจะเป็นการเขียน provider เองหรือใช้ provider ที่มีมาให้กับ .net framework ซึ่งได้แก่ MembershipProvider โดยจะขอเริ่มพูดในส่วนของ API Key ซึ่งจะใช้คลาส HttpMessageHandler (ทำงานใน http message level ดีกว่าไปทำใน controller แน่นอนครับ) วิธี implement คือ การสร้าง Class ที่ inherite มาจาก DelegatingHandler (ซึ่งมาจาก HttpMessageHandler อีกที) จะให้ override ส่วนของการตรวจสอบ HTTP Request โดยการทำ overriding method ชื่อ SendAsync และเพื่อให้ทำงานได้ จะต้องทำการ register handler ที่ Global.asax ใน Application_Start ด้วยครับ ด้วยคำสั่ง GlobalConfiguration.Configuration.MessageHandlers.Add(new MY_CLASS());

API Key Authentication

เราจะต้องมี API Key โดยสามารถเก็บไว้เป็นค่าคงที่ หรือเก็บไว้เป็นข้อมูลในฐานข้อมูล จากนั้นทำการตรวจสอบ Request ที่เข้ามาด้วยคำสั่งต่อไปนี้

HttpRequestMessage.Headers.TryGetValues(“API_KEY”, out myHeader)
(ต้องทำการสร้าง instance ของ HttpRequestMessage ก่อนนะครับ — myHeader เป็น type IEnumerable<string>)

จากนั้นเรานำค่าในตัวแปรมาตรวจสอบกับ API Key ของเรา ที่เราเก็บไว้ เช่น

ถ้าเก็บไว้เป็นค่าคงที่ ก็ตรวจสอบดังนี้

myHeader.FirstOrDefault().Equals(“MySecretAPIKeyNaJa”);

หรือถ้าเก็บไว้ในฐานข้อมูล ก็ตรวจสอบดังนี้

db.API_KEY.Where(w => w.KEY == myHeader.FirstOrDefault()).Count() > 0 เป็นต้น

หากเป็น API Key ที่ถูกต้อง สามารถ return response ดังนี้ได้ทันที await base.SendAsync(HttpRequestMessage, CancellationToken);
ส่วนถ้าเป็น API Key ที่ไม่ถูกต้อง สามารถ return response ดังนี้ เพื่อให้ browser รู้ว่าเกิดอะไรขึ้น HttpRequestMessage.CreateResponse(HttpStatusCode.Forbidden, “Invalid API Key”);

Authorization

การทำ authorization นี้จะใช้งาน RoleProvider จาก .NET Framework ซึ่งจะต้องทำการ Implement role provider มาก่อน (รายละเอียด: https://msdn.microsoft.com/en-us/library/8fw7xh74.aspx)

หลังจากการทำยืนยันตัวตน (Authentication) แล้ว ควรจะทำการตรวจสอบการอนุญาตให้เข้าถึงทรัพยากรหรือการกระทำ (action) ด้วย ด้วยการใช้งาน AuthorizeAttribute ซึ่งเป็น filter attribute ด้วยวิธีการง่ายๆ เพียงการใส่ [Authorize] ไว้บน Controller (Class) หรือ Action (Method) ซึ่งจะมี attribute [AllowAnonymous] ให้สามารถใช้ได้ สำหรับ controller, action ที่ไม่ต้องการการ authentication หรือ authorization ครับ

นอกจากนี้เรายังสามารถระบุ role กับ attribute ได้อีกด้วย เช่น [Authorize{Roles = “Manager, ValidUsers”}] เป็นต้นครับ

บทความนี้นำเสนอขั้นตอนการพัฒนา Unit Test อย่างง่ายโดยแสดงให่้เห็นการพัฒนาทีละขั้นตอน สำหรับระบบที่พัฒนาบน .NET Core โดยใช้ MSTest เพื่อทำความเข้าใจการพัฒนาแบบ test-driven development (TDD) ซึ่งในขั้นแรก เริ่มต้นด้วยการสร้าง source project ชื่อ “CalcTool” ใช้สำหรับการทดสอบ อยู่ภายใต้ folder “TestSample” ซึ่งขั้นตอนการสร้าง project สามารถดูได้จาก บทความ การพัฒนา Unit Testing โดย xUnit test library (.NET Core) ซึ่งจะได้ class “Calc” ซึ่งประกอบไปด้วย method “AbsAddByOne(int value)” ที่ยังไม่ได้เขียน code การทำงาน

สร้าง test project ที่ใช้ MSTest library โดยเปิด command prompt เข้าไปที่ folder “TestSample” และสร้าง sub folder ชื่อ “CalcTool.MSTests” จากนั้นเข้าไปที่ folder “CalcTool.MSTests” ทำการสร้าง .NET Core project โดยใช้คำสั่ง

dotnet new mstest

โดยคำสั่งนี้จะทำการสร้าง test project ที่ใช้ MSTest test library และกำหนดค่า test runner

<ItemGroup>
    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="15.0.0"/>
    <PackageReference Include="MSTest.TestAdapter" Version="1.1.11"/>
    <PackageReference Include="MSTest.TestFramework" Version="1.1.11"/>
</ItemGroup>

เพิ่ม reference ไปยัง project ที่ต้องการทดสอบซึ่งในที่นี้คือ CalcTool project โดยใช้คำสั่ง

dotnet add reference ../CalcTool/CalcTool.csproj

จากนั้นให้ execute คำสั่ง dotnet restore เพื่อ restore NuGet package ที่จำเป็นต้องใช้ในแต่ละ project

เริ่มพัฒนา unit testing โดยลบ file “UnitTest1.cs” และสร้าง file ใหม่โดยใช้ชื่อว่า “CalcTest.cs” และเขียน code ดังนี้

using System;
using Microsoft.VisualStudio.TestTools.UnitTesting;

namespace CalcTool.MSTest
{
    [TestClass]
    public class CalcTest
    {
        [TestMethod]
        public void AbsAddByOneTest()
        {
            var c = new Calc();
            var result = c.AbsAddByOne(5);

            Assert.AreEqual(result, 6);
        }
    }
}

*[TestClass] attribute ใช้เพื่อบอกว่ามี unit test อยู่ใน class นั้น
*[TestMethod] attribute ใช้เพื่อกำหนดว่า method นั้นๆเป็นแบบ single test

ทำการทดสอบโดยการ execute dotnet test ซึ่งจะทำการ build และ start MSTest test runner ซึ่งพบว่าผลการทดสอบ fail เนื่องจากยังไม่ได้ implement code ใน method “AbsAddByOne” ของ class “Calc” ดังนั้นกลับไปที่ method “AbsAddByOne” เพิ่ม code ลงไปเพื่อให้ผลการทดสอบถูกต้อง/ผ่าน (test pass)

        public int AbsAddByOne(int value)
        {
            return Math.Abs(value) + 1;
            //throw new NotImplementedException("Not implement");
        }

กลับไปที่ folder “CalcTool.MSTests” และ execute dotnet test ซึ่งจะทำการ build และ start MSTest test runner ซึ่งพบว่า ผ่านการทดสอบ (test pass)

MSTest มี attribute ที่ใช้กำหนด suite of tests ซึ่ง execute code เดียวกันแต่มี input ที่มีค่าแตกต่างกันนั่นคือ [DataTestMethod] attribute และใช้ [DataRow] attribute ในการกำหนดค่าของ input

        [DataTestMethod]
        [DataRow(5)]
        [DataRow(-5)]
        public void AbsAddByOneTest2(int value)
        {
            var c = new Calc();
            var result = c.AbsAddByOne(value);

            Assert.AreEqual(result, 6);
        }

การพัฒนาในรูปแบบ test-driven development (TDD) จะทำเป็นรอบๆในลักษณะนี้โดย เพิ่ม unit testing , เพิ่ม code ใหม่เข้าไป ทดสอบ unit test จนผ่านและเริ่มรอบใหม่ จนกระทั่งได้ test ชุดสุดท้ายและโปรแกรม/library ที่สมบูรณ์ ก็เป็นอันจบการพัฒนาในรูปแบบ test-driven development (TDD)