Cover dynamic array with tests (#318)

Author: siriak

CONTRIBUTING.md

@@ -147,7 +147,7 @@ Common prefixes:
 
 ### Pull Requests
 
-- Checkout our [pull request template](https://github.com/TheAlgorithms/Go/blob/master/.github/PULL_REQUEST_TEMPLATE/pull_request.go
+- Checkout our [pull request template](https://github.com/TheAlgorithms/Go/blob/master/.github/PULL_REQUEST_TEMPLATE/pull_request.md
   )
 
 #### Building Locally

DIRECTORY.md

@@ -33,8 +33,9 @@
     * [Binary Tree](https://github.com/TheAlgorithms/Go/blob/master/data_structures/binary_tree/binary_tree.go)
     * [Btree](https://github.com/TheAlgorithms/Go/blob/master/data_structures/binary_tree/btree.go)
     * [Node](https://github.com/TheAlgorithms/Go/blob/master/data_structures/binary_tree/node.go)
-  * Dynamic-Array
-    * [Dynamic Array](https://github.com/TheAlgorithms/Go/blob/master/data_structures/dynamic-array/dynamic_array.go)
+  * Dynamic Array
+    * [Dynamic Array](https://github.com/TheAlgorithms/Go/blob/master/data_structures/dynamic_array/dynamic_array.go)
+    * [Dynamic Array Test](https://github.com/TheAlgorithms/Go/blob/master/data_structures/dynamic_array/dynamic_array_test.go)
   * Hashmap
     * [Hashmap](https://github.com/TheAlgorithms/Go/blob/master/data_structures/hashmap/hashmap.go)
     * [Hashmap Test](https://github.com/TheAlgorithms/Go/blob/master/data_structures/hashmap/hashmap_test.go)

data_structures/dynamic-array/dynamic_array.go renamed to data_structures/dynamic_array/dynamic_array.go

@@ -1,19 +1,34 @@
+// Dynamic Array
+// description: A dynamic array is quite similar to a regular array, but its size is modifiable during program runtime.
+// details: for more details check out those links below here:
+// geeks for geeks article : https://www.geeksforgeeks.org/how-do-dynamic-arrays-work/
+// We can mention that Dynamic Array is like Slice for more detail about `Go` Slices check those articles :
+//	https://blog.golang.org/slices-intro
+// 	https://blog.golang.org/slices
+// authors [Wesllhey Holanda](https://github.com/wesllhey), [Milad](https://github.com/miraddo)
+// see dynamic_array.go, dynamic_array_test.go
+
 package dynamicarray
 
+
+// errors: used to handle CheckRangeFromIndex function with a reasonable error value
 import (
 	"errors"
 )
 
 var defaultCapacity = 10
 
 // DynamicArray structure
+// size: length of array
+// capacity: the maximum length of the segment
+// elementData: an array of any type of data with interface
 type DynamicArray struct {
 	size        int
 	capacity    int
 	elementData []interface{}
 }
 
-// Put function
+// Put function is change/update the value in array with the index and new value
 func (da *DynamicArray) Put(index int, element interface{}) error {
 	err := da.CheckRangeFromIndex(index)
 
@@ -26,7 +41,7 @@ func (da *DynamicArray) Put(index int, element interface{}) error {
 	return nil
 }
 
-// Add function
+// Add function is add new element to our array
 func (da *DynamicArray) Add(element interface{}) {
 	if da.size == da.capacity {
 		da.NewCapacity()
@@ -36,7 +51,7 @@ func (da *DynamicArray) Add(element interface{}) {
 	da.size++
 }
 
-// Remove function
+// Remove function is remove an element with the index
 func (da *DynamicArray) Remove(index int) error {
 	err := da.CheckRangeFromIndex(index)
 
@@ -52,7 +67,7 @@ func (da *DynamicArray) Remove(index int) error {
 	return nil
 }
 
-// Get function
+// Get function is return one element with the index of array
 func (da *DynamicArray) Get(index int) (interface{}, error) {
 	err := da.CheckRangeFromIndex(index)
 
@@ -63,25 +78,25 @@ func (da *DynamicArray) Get(index int) (interface{}, error) {
 	return da.elementData[index], nil
 }
 
-// IsEmpty function
+// IsEmpty function is check that the array has value or not
 func (da *DynamicArray) IsEmpty() bool {
 	return da.size == 0
 }
 
-// GetData function
+// GetData function return all value of array
 func (da *DynamicArray) GetData() []interface{} {
 	return da.elementData[:da.size]
 }
 
-// CheckRangeFromIndex function
+// CheckRangeFromIndex function it will check the range from the index
 func (da *DynamicArray) CheckRangeFromIndex(index int) error {
 	if index >= da.size || index < 0 {
 		return errors.New("index out of range")
 	}
 	return nil
 }
 
-// NewCapacity function
+// NewCapacity function increase the capacity
 func (da *DynamicArray) NewCapacity() {
 	if da.capacity == 0 {
 		da.capacity = defaultCapacity
@@ -95,28 +110,3 @@ func (da *DynamicArray) NewCapacity() {
 
 	da.elementData = newDataElement
 }
-
-// func main() {
-// 	numbers := dynamicArray{}
-// 	fmt.Println(numbers.isEmpty())
-
-// 	numbers.add(10)
-// 	numbers.add(20)
-// 	numbers.add(30)
-// 	numbers.add(40)
-// 	numbers.add(50)
-
-// 	fmt.Println(numbers.isEmpty())
-
-// 	fmt.Println(numbers.getData())
-
-// 	numbers.remove(1)
-
-// 	fmt.Println(numbers.getData())
-
-// 	numberFound, _ := numbers.get(1)
-// 	fmt.Println(numberFound)
-
-// 	numbers.put(0, 100)
-// 	fmt.Println(numbers.getData())
-// }

data_structures/dynamic_array/dynamic_array_test.go

@@ -0,0 +1,101 @@
+package dynamicarray
+
+
+// reflect: used for check equal values
+import (
+	"reflect"
+	"testing"
+)
+
+// TestDynamicArray some test for dynamic array to make sure everything is ok, and we got the right result
+func TestDynamicArray(t *testing.T) {
+	numbers := DynamicArray{}
+
+	// check numbers is empty or nut
+	t.Run("Check Empty Dynamic Array", func(t *testing.T) {
+		if numbers.IsEmpty() != true{
+			t.Errorf("Expected be true but got %v", numbers.IsEmpty())
+		}
+	})
+
+	numbers.Add(10)
+	numbers.Add(20)
+	numbers.Add(30)
+	numbers.Add(40)
+	numbers.Add(50)
+
+	// check numbers added to our dynamic array
+	t.Run("Add Element into Dynamic Array", func(t *testing.T) {
+		if numbers.IsEmpty() != false{
+			t.Errorf("Expected be false but got %v", numbers.IsEmpty())
+		}
+		var res []interface{}
+		res = append(res, 10)
+		res = append(res, 20)
+		res = append(res, 30)
+		res = append(res, 40)
+		res = append(res, 50)
+
+		if !reflect.DeepEqual(numbers.GetData(), res) {
+			t.Errorf("Expected be [10, 20, 30, 40, 50] but got %v", numbers.GetData())
+		}
+	})
+
+	// Remove an Element inside the dynamic array with the index of array
+	t.Run("Remove in Dynamic Array", func(t *testing.T) {
+		if numbers.IsEmpty() != false{
+			t.Errorf("Expected be false but got %v", numbers.IsEmpty())
+		}
+		var res []interface{}
+		res = append(res, 10)
+		res = append(res, 30)
+		res = append(res, 40)
+		res = append(res, 50)
+
+		// remove the element by the index
+		err := numbers.Remove(1)
+
+		if err != nil{
+			t.Errorf("Expected be [10, 30, 40, 50] but got an Error %v", err)
+		}
+
+		if !reflect.DeepEqual(numbers.GetData(), res) {
+			t.Errorf("Expected be [10, 30, 40, 50] but got %v", numbers.GetData())
+		}
+	})
+
+	// get one element by the index of the dynamic array
+	t.Run("Get in Dynamic Array", func(t *testing.T) {
+		if numbers.IsEmpty() != false{
+			t.Errorf("Expected be false but got %v", numbers.IsEmpty())
+		}
+
+		// return one element with the index
+		getOne,_ := numbers.Get(2)
+
+		if getOne != 40 {
+			t.Errorf("Expected be 40 but got %v", getOne)
+		}
+
+	})
+
+
+	// Put to add a value to specific index of Dynamic Array
+	t.Run("Put to Dynamic Array", func(t *testing.T) {
+		if numbers.IsEmpty() != false{
+			t.Errorf("Expected be false but got %v", numbers.IsEmpty())
+		}
+
+		// change value of specific index
+		err := numbers.Put(0, 100)
+		if err != nil{
+			t.Errorf("Expected be [10, 30, 40, 50] but got an Error %v", err)
+		}
+
+		getOne,_ := numbers.Get(0)
+		if getOne != 100 {
+			t.Errorf("Expected be 100 but got %v", getOne)
+		}
+	})
+
+}