mirror of
https://github.com/ckaczor/sqltoolsservice.git
synced 2026-01-14 01:25:40 -05:00
This is a very large change. I'll try to outline what's going on.
1. This adds the **EditDataService** which manages editing **Sessions**.
1. Each session has a **ResultSet** (from the QueryExecutionService) which has the rows of the table and basic metadata about the columns
2. Each session also has an **IEditTableMetadata** implementation which is derived from SMO metadata which provides more in-depth and trustworthy data about the table than SqlClient alone can.
3. Each session holds a list of **RowEditBase** abstract class implementations
1. **RowUpdate** - Update cells in a row (generates `UPDATE` statement)
2. **RowDelete** - Delete an entire row (generates `DELETE` statement)
3. **RowCreate** - Add a new row (generates `INSERT INTO` statement)
4. Row edits have a collection of **CellUpdates** that hold updates for individual cells (except for RowDelete)
1. Cell updates are generated from text
5. RowEditBase offers some baseline functionality
1. Generation of `WHERE` clauses (which can be parameterized)
2. Validation of whether a column can be updated
2. New API Actions
1. edit/initialize - Queries for the contents of a table/view, builds SMO metadata, sets up a session
2. edit/createRow - Adds a new RowCreate to the Session
3. edit/deleteRow - Adds a new RowDelete to the Session
4. edit/updateCell - Adds a CellUpdate to a RowCreate or RowUpdate in the Session
5. edit/revertRow - Removes a RowCreate, RowDelete, or RowUpdate from the Session
6. edit/script - Generates a script for the changes in the Session and stores to disk
7. edit/dispose - Removes a Session and releases the query
3. Smaller updates (unit test mock improvements, tweaks to query execution service)
**There are more updates planned -- this is just to get eyeballs on the main body of code**
* Initial stubs for edit data service
* Stubbing out update management code
* Adding rudimentary dispose request
* More stubbing out of update row code
* Adding complete edit command contracts, stubbing out request handlers
* Adding basic implementation of get script
* More in progress work to implement base of row edits
* More in progress work to implement base of row edits
* Adding string => object conversion logic and various cleanup
* Adding a formatter for using values in scripts
* Splitting IMessageSender into IEventSender and IRequestSender
* Adding inter-service method for executing queries
* Adding inter-service method for disposing of a query
* Changing edit contract to include the object to edit
* Fully fleshing out edit session initialization
* Generation of delete scripts is working
* Adding scripter for update statements
* Adding scripting functionality for INSERT statements
* Insert, Update, and Delete all working with SMO metadata
* Polishing for SqlScriptFormatter
* Unit tests and reworked byte[] conversion
* Replacing the awful and inflexible Dictionary<string, string>[][] with a much better test data set class
* Fixing syntax error in generated UPDATE statements
* Adding unit tests for RowCreate
* Adding tests for the row edit base class
* Adding row delete tests
* Adding RowUpdate tests, validation for number of key columns
* Adding tests for the unit class
* Adding get script tests for the session
* Service integration tests, except initialization tests
* Service integration tests, except initialization tests
* Adding messages to sr.strings
* Adding messages to sr.strings
* Fixing broken unit tests
* Adding factory pattern for SMO metadata provider
* Copyright and other comments
* Addressing first round of comments
* Refactoring EditDataService to have a single method for handling
session-dependent operations
* Refactoring Edit Data contracts to inherit from a Session and Row
operation params base class
* Copyright additions
* Small tweak to strings
* Updated unit tests to test the refactors
* More revisions as per pull request comments
209 lines
9.5 KiB
C#
209 lines
9.5 KiB
C#
//
|
|
// Copyright (c) Microsoft. All rights reserved.
|
|
// Licensed under the MIT license. See LICENSE file in the project root for full license information.
|
|
//
|
|
|
|
using System;
|
|
using System.Collections.Generic;
|
|
using System.Data.Common;
|
|
using Microsoft.SqlTools.ServiceLayer.EditData.UpdateManagement;
|
|
using Xunit;
|
|
|
|
namespace Microsoft.SqlTools.ServiceLayer.Test.EditData
|
|
{
|
|
public class CellUpdateTests
|
|
{
|
|
[Fact]
|
|
public void NullColumnTest()
|
|
{
|
|
// If: I attempt to create a CellUpdate with a null column
|
|
// Then: I should get an exception thrown
|
|
Assert.Throws<ArgumentNullException>(() => new CellUpdate(null, string.Empty));
|
|
}
|
|
|
|
[Fact]
|
|
public void NullStringValueTest()
|
|
{
|
|
// If: I attempt to create a CellUpdate with a null string value
|
|
// Then: I should get an exception thrown
|
|
Assert.Throws<ArgumentNullException>(() => new CellUpdate(new CellUpdateTestDbColumn(null), null));
|
|
}
|
|
|
|
[Fact]
|
|
public void NullStringTest()
|
|
{
|
|
// If: I attempt to create a CellUpdate to set it to NULL (with mixed cases)
|
|
const string nullString = "NULL";
|
|
DbColumn col = new CellUpdateTestDbColumn(typeof(string));
|
|
CellUpdate cu = new CellUpdate(col, nullString);
|
|
|
|
// Then: The value should be a DBNull and the string value should be the same as what
|
|
// was given
|
|
Assert.IsType<DBNull>(cu.Value);
|
|
Assert.Equal(DBNull.Value, cu.Value);
|
|
Assert.Equal(nullString, cu.ValueAsString);
|
|
Assert.Equal(col, cu.Column);
|
|
}
|
|
|
|
[Fact]
|
|
public void NullTextStringTest()
|
|
{
|
|
// If: I attempt to create a CellUpdate with the text 'NULL' (with mixed case)
|
|
DbColumn col = new CellUpdateTestDbColumn(typeof(string));
|
|
CellUpdate cu = new CellUpdate(col, "'NULL'");
|
|
|
|
// Then: The value should be NULL
|
|
Assert.IsType<string>(cu.Value);
|
|
Assert.Equal("NULL", cu.Value);
|
|
Assert.Equal("'NULL'", cu.ValueAsString);
|
|
Assert.Equal(col, cu.Column);
|
|
}
|
|
|
|
[Theory]
|
|
[MemberData(nameof(ByteArrayTestParams))]
|
|
public void ByteArrayTest(string strValue, byte[] expectedValue, string expectedString)
|
|
{
|
|
// If: I attempt to create a CellUpdate for a binary column
|
|
DbColumn col = new CellUpdateTestDbColumn(typeof(byte[]));
|
|
CellUpdate cu = new CellUpdate(col, strValue);
|
|
|
|
// Then: The value should be a binary and should match the expected data
|
|
Assert.IsType<byte[]>(cu.Value);
|
|
Assert.Equal(expectedValue, cu.Value);
|
|
Assert.Equal(expectedString, cu.ValueAsString);
|
|
Assert.Equal(col, cu.Column);
|
|
}
|
|
|
|
public static IEnumerable<object> ByteArrayTestParams
|
|
{
|
|
get
|
|
{
|
|
// All zero tests
|
|
yield return new object[] {"00000000", new byte[] {0x00}, "0x00"}; // Base10
|
|
yield return new object[] {"0x000000", new byte[] {0x00, 0x00, 0x00}, "0x000000"}; // Base16
|
|
yield return new object[] {"0x000", new byte[] {0x00, 0x00}, "0x0000"}; // Base16, odd
|
|
|
|
// Single byte tests
|
|
yield return new object[] {"50", new byte[] {0x32}, "0x32"}; // Base10
|
|
yield return new object[] {"050", new byte[] {0x32}, "0x32"}; // Base10, leading zeros
|
|
yield return new object[] {"0xF0", new byte[] {0xF0}, "0xF0"}; // Base16
|
|
yield return new object[] {"0x0F", new byte[] {0x0F}, "0x0F"}; // Base16, leading zeros
|
|
yield return new object[] {"0xF", new byte[] {0x0F}, "0x0F"}; // Base16, odd
|
|
|
|
// Two byte tests
|
|
yield return new object[] {"1000", new byte[] {0x03, 0xE8}, "0x03E8"}; // Base10
|
|
yield return new object[] {"01000", new byte[] {0x03, 0xE8}, "0x03E8"}; // Base10, leading zeros
|
|
yield return new object[] {"0xF001", new byte[] {0xF0, 0x01}, "0xF001"}; // Base16
|
|
yield return new object[] {"0x0F10", new byte[] {0x0F, 0x10}, "0x0F10"}; // Base16, leading zeros
|
|
yield return new object[] {"0xF10", new byte[] {0x0F, 0x10}, "0x0F10"}; // Base16, odd
|
|
|
|
// Three byte tests
|
|
yield return new object[] {"100000", new byte[] {0x01, 0x86, 0xA0}, "0x0186A0"}; // Base10
|
|
yield return new object[] {"0100000", new byte[] {0x01, 0x86, 0xA0}, "0x0186A0"}; // Base10, leading zeros
|
|
yield return new object[] {"0x101010", new byte[] {0x10, 0x10, 0x10}, "0x101010"}; // Base16
|
|
yield return new object[] {"0x010101", new byte[] {0x01, 0x01, 0x01}, "0x010101"}; // Base16, leading zeros
|
|
yield return new object[] {"0x10101", new byte[] {0x01, 0x01, 0x01}, "0x010101"}; // Base16, odd
|
|
|
|
// Four byte tests
|
|
yield return new object[] {"20000000", new byte[] {0x01, 0x31, 0x2D, 0x00}, "0x01312D00"}; // Base10
|
|
yield return new object[] {"020000000", new byte[] {0x01, 0x31, 0x2D, 0x00}, "0x01312D00"}; // Base10, leading zeros
|
|
yield return new object[] {"0xF0F00101", new byte[] {0xF0, 0xF0, 0x01, 0x01}, "0xF0F00101"}; // Base16
|
|
yield return new object[] {"0x0F0F1010", new byte[] {0x0F, 0x0F, 0x10, 0x10}, "0x0F0F1010"}; // Base16, leading zeros
|
|
yield return new object[] {"0xF0F1010", new byte[] {0x0F, 0x0F, 0x10, 0x10}, "0x0F0F1010"}; // Base16, odd
|
|
}
|
|
}
|
|
|
|
[Fact]
|
|
public void ByteArrayInvalidFormatTest()
|
|
{
|
|
// If: I attempt to create a CellUpdate for a binary column
|
|
// Then: It should throw an exception
|
|
DbColumn col = new CellUpdateTestDbColumn(typeof(byte[]));
|
|
Assert.Throws<FormatException>(() => new CellUpdate(col, "this is totally invalid"));
|
|
}
|
|
|
|
[Theory]
|
|
[MemberData(nameof(BoolTestParams))]
|
|
public void BoolTest(string input, bool output, string outputString)
|
|
{
|
|
// If: I attempt to create a CellUpdate for a boolean column
|
|
DbColumn col = new CellUpdateTestDbColumn(typeof(bool));
|
|
CellUpdate cu = new CellUpdate(col, input);
|
|
|
|
// Then: The value should match what was expected
|
|
Assert.IsType<bool>(cu.Value);
|
|
Assert.Equal(output, cu.Value);
|
|
Assert.Equal(outputString, cu.ValueAsString);
|
|
Assert.Equal(col, cu.Column);
|
|
}
|
|
|
|
public static IEnumerable<object> BoolTestParams
|
|
{
|
|
get
|
|
{
|
|
yield return new object[] {"1", true, bool.TrueString};
|
|
yield return new object[] {"0", false, bool.FalseString};
|
|
yield return new object[] {bool.TrueString, true, bool.TrueString};
|
|
yield return new object[] {bool.FalseString, false, bool.FalseString};
|
|
}
|
|
}
|
|
|
|
[Fact]
|
|
public void BoolInvalidFormatTest()
|
|
{
|
|
// If: I create a CellUpdate for a bool column and provide an invalid numeric value
|
|
// Then: It should throw an exception
|
|
DbColumn col = new CellUpdateTestDbColumn(typeof(bool));
|
|
Assert.Throws<ArgumentOutOfRangeException>(() => new CellUpdate(col, "12345"));
|
|
}
|
|
|
|
[Theory]
|
|
[MemberData(nameof(RoundTripTestParams))]
|
|
public void RoundTripTest(Type dbColType, object obj)
|
|
{
|
|
// Setup: Figure out the test string
|
|
string testString = obj.ToString();
|
|
|
|
// If: I attempt to create a CellUpdate for a GUID column
|
|
DbColumn col = new CellUpdateTestDbColumn(dbColType);
|
|
CellUpdate cu = new CellUpdate(col, testString);
|
|
|
|
// Then: The value and type should match what we put in
|
|
Assert.IsType(dbColType, cu.Value);
|
|
Assert.Equal(obj, cu.Value);
|
|
Assert.Equal(testString, cu.ValueAsString);
|
|
Assert.Equal(col, cu.Column);
|
|
}
|
|
|
|
public static IEnumerable<object> RoundTripTestParams
|
|
{
|
|
get
|
|
{
|
|
yield return new object[] {typeof(Guid), Guid.NewGuid()};
|
|
yield return new object[] {typeof(TimeSpan), new TimeSpan(0, 1, 20, 0, 123)};
|
|
yield return new object[] {typeof(DateTime), new DateTime(2016, 04, 25, 9, 45, 0)};
|
|
yield return new object[]
|
|
{
|
|
typeof(DateTimeOffset),
|
|
new DateTimeOffset(2016, 04, 25, 9, 45, 0, TimeSpan.FromHours(8))
|
|
};
|
|
yield return new object[] {typeof(long), 1000L};
|
|
yield return new object[] {typeof(decimal), new decimal(3.14)};
|
|
yield return new object[] {typeof(int), 1000};
|
|
yield return new object[] {typeof(short), (short) 1000};
|
|
yield return new object[] {typeof(byte), (byte) 5};
|
|
yield return new object[] {typeof(double), 3.14d};
|
|
yield return new object[] {typeof(float), 3.14f};
|
|
}
|
|
}
|
|
|
|
private class CellUpdateTestDbColumn : DbColumn
|
|
{
|
|
public CellUpdateTestDbColumn(Type dataType)
|
|
{
|
|
DataType = dataType;
|
|
}
|
|
}
|
|
}
|
|
}
|