Added more unit tests

README.md

@@ -16,6 +16,7 @@ Clone this repository and run `go build` to build the executable.
 ## Available options
 * `-debug` - enables debug mode
 * `-output some_directory` - Output path (default "./downloads")
+* `-metadata` - Write video metadata to a .json file
 
 ## Acknowledgments
 This software uses the chromedp for web scraping, it can be found here: https://github.com/chromedp/chromedp

main.go

@@ -1,12 +1,8 @@
 package main
 
 import (
-	client "./client"
 	models "./models"
-	utils "./utils"
+	workflows "./workflows"
-	"fmt"
-	"regexp"
-	"strings"
 )
 
 func main() {
@@ -14,49 +10,16 @@ func main() {
 	url := models.Config.URL
 
 	// Single video
-	match, _ := regexp.MatchString("\\/@.+\\/video\\/[0-9]+", url)
+	if workflows.CanUseDownloadSingleVideo(url) {
-	if match {
+		workflows.DownloadSingleVideo(url)
-		getUsernameFromVidURLRegex, _ := regexp.Compile("com\\/@.*")
-		parts := strings.Split(getUsernameFromVidURLRegex.FindString(url), "/")
-		username := parts[1][1:]
-		upload := client.GetVideoDetails(url)
-		downloadDir := fmt.Sprintf("%s/%s", models.Config.OutputPath, username)
-
-		utils.InitOutputDirectory(downloadDir)
-		downloadVideo(upload, downloadDir)
 		return
 	}
 
 	// Tiktok user
-	downloadUser()
+	if workflows.CanUseDownloadUser(url) {
-}
+		workflows.DownloadUser(models.GetUsername())
-
-func downloadVideo(upload models.Upload, downloadDir string) {
-	uploadID := upload.GetUploadID()
-	downloadPath := fmt.Sprintf("%s/%s.mp4", downloadDir, uploadID)
-
-	if utils.CheckIfExists(downloadPath) {
-		fmt.Println("Upload '" + uploadID + "' already downloaded, skipping")
 		return
 	}
 
-	fmt.Println("Downloading upload item '" + uploadID + "' to " + downloadPath)
+	panic("Could not recognise URL format")
-	utils.DownloadFile(downloadPath, upload.URL)
-
-	if models.Config.MetaData {
-		metadataPath := fmt.Sprintf("%s/%s.json", downloadDir, uploadID)
-		upload.WriteToFile(metadataPath)
-	}
-}
-
-func downloadUser() {
-	username := models.Config.URL
-	downloadDir := fmt.Sprintf("%s/%s", models.Config.OutputPath, username)
-	uploads := client.GetUserUploads(username)
-
-	utils.InitOutputDirectory(downloadDir)
-
-	for _, upload := range uploads {
-		downloadVideo(upload, downloadDir)
-	}
 }

models/config.go

@@ -4,6 +4,8 @@ import (
 	"flag"
 	"fmt"
 	"os"
+	"regexp"
+	"strings"
 )
 
 // Config - Runtime configuration
@@ -32,3 +34,17 @@ func GetConfig() {
 	Config.Debug = *debug
 	Config.MetaData = *metadata
 }
+
+// GetUsername - Get's username from passed URL param
+func GetUsername() string {
+	if match := strings.Contains(Config.URL, "/"); !match { // Not url
+		return strings.Replace(Config.URL, "@", "", -1)
+	}
+
+	if match, _ := regexp.MatchString(".+tiktok\\.com/@.+", Config.URL); match { // URL
+		stripedSuffix := strings.Split(Config.URL, "@")[1]
+		return strings.Split(stripedSuffix, "/")[0]
+	}
+
+	panic("Could not recognise URL format")
+}

models/config_test.go

@@ -0,0 +1,36 @@
+package models
+
+import (
+	testUtil "../unitTestUtil"
+	"testing"
+)
+
+func TestGetUsername(t *testing.T) {
+	testCaseDelegate := func(t *testing.T, url string, username string) {
+		tu := testUtil.TestUtil{T: t}
+		Config.URL = url
+		actual := GetUsername()
+		tu.AssertString(actual, username, "Username")
+	}
+
+	testVideoURL := func(t *testing.T) {
+		testCaseDelegate(t, "https://www.tiktok.com/@some_username/video/0000000000000000000", "some_username")
+	}
+
+	testProfileURL := func(t *testing.T) {
+		testCaseDelegate(t, "https://www.tiktok.com/@some_username", "some_username")
+	}
+
+	testPlainUsername := func(t *testing.T) {
+		testCaseDelegate(t, "some_username", "some_username")
+	}
+
+	testAtUsername := func(t *testing.T) {
+		testCaseDelegate(t, "@some_username", "some_username")
+	}
+
+	t.Run("Video URL", testVideoURL)
+	t.Run("Username URL", testProfileURL)
+	t.Run("Plain username", testPlainUsername)
+	t.Run("Username with @ suffix", testAtUsername)
+}

models/upload_test.go

@@ -1,36 +1,67 @@
 package models
 
-import "testing"
+import (
+	testUtil "../unitTestUtil"
+	utils "../utils"
+	"os"
+	"testing"
+)
 
-// TestParseUploads - Test parsing
 func TestParseUploads(t *testing.T) {
-	jsonStr := "[{\"shareLink\":\"some_share_link\", \"url\": \"some_url\"}]"
+	tu := testUtil.TestUtil{T: t}
+	jsonStr := "[{\"url\":\"some_url\",\"shareLink\":\"some_share_link\",\"caption\":\"some_caption\",\"sound\":{\"title\":\"some_title\",\"link\":\"some_link\"}}]"
 	actual := ParseUploads(jsonStr)
 
-	expectedLen := 1
+	tu.AssertInt(len(actual), 1, "Array len")
-	if len(actual) != expectedLen {
-		t.Errorf("Array len incorrect: Expected %d, but got %d", expectedLen, len(actual))
-	}
 
-	expectedShareLink := "some_share_link"
+	tu.AssertString(actual[0].URL, "some_url", "URL")
-	if actual[0].ShareLink != expectedShareLink {
+	tu.AssertString(actual[0].Caption, "some_caption", "Caption")
-		t.Errorf("ShareLink is incorrect: Expected %s, but got %s", expectedShareLink, actual[0].ShareLink)
+	tu.AssertString(actual[0].ShareLink, "some_share_link", "ShareLink")
-	}
 
-	expectedURL := "some_url"
+	tu.AssertString(actual[0].Sound.Link, "some_link", "Sound.Link")
-	if actual[0].URL != expectedURL {
+	tu.AssertString(actual[0].Sound.Title, "some_title", "Sound.Title")
-		t.Errorf("URL is incorrect: Expected %s, but got %s", expectedURL, actual[0].URL)
+}
-	}
+
+func TestParseUpload(t *testing.T) {
+	tu := testUtil.TestUtil{T: t}
+	jsonStr := "{\"url\":\"some_url\",\"shareLink\":\"some_share_link\",\"caption\":\"some_caption\",\"sound\":{\"title\":\"some_title\",\"link\":\"some_link\"}}"
+	actual := ParseUpload(jsonStr)
+
+	tu.AssertString(actual.URL, "some_url", "URL")
+	tu.AssertString(actual.Caption, "some_caption", "Caption")
+	tu.AssertString(actual.ShareLink, "some_share_link", "ShareLink")
+
+	tu.AssertString(actual.Sound.Link, "some_link", "Sound.Link")
+	tu.AssertString(actual.Sound.Title, "some_title", "Sound.Title")
 }
 
 func TestGetUploadID(t *testing.T) {
+	tu := testUtil.TestUtil{T: t}
 	var upload Upload
 	upload.ShareLink = "http://pikami.org/some_thing/some_upload_id"
-	expected := "some_upload_id"
-
 	actual := upload.GetUploadID()
 
-	if actual != expected {
+	tu.AssertString(actual, "some_upload_id", "Upload ID")
-		t.Errorf("UploadId is incorrect: Expected %s, but got %s", expected, actual)
+}
-	}
+
+func TestWriteToFile(t *testing.T) {
+	tu := testUtil.TestUtil{T: t}
+	expected := "{\"url\":\"some_url\",\"shareLink\":\"some_share_link\",\"caption\":\"some_caption\",\"sound\":{\"title\":\"some_title\",\"link\":\"some_link\"}}"
+	filePath := "test_file.txt"
+	upload := Upload{
+		URL:       "some_url",
+		Caption:   "some_caption",
+		ShareLink: "some_share_link",
+		Sound: Sound{
+			Link:  "some_link",
+			Title: "some_title",
+		},
+	}
+
+	upload.WriteToFile(filePath)
+
+	actual := utils.ReadFileToString(filePath)
+	tu.AssertString(actual, expected, "File content")
+
+	os.Remove(filePath)
 }

unitTestUtil/assert.go

@@ -0,0 +1,15 @@
+package unittestutil
+
+// AssertString - Check if two strings match
+func (tu *TestUtil) AssertString(actual string, expected string, name string) {
+	if actual != expected {
+		tu.T.Errorf("%s is incorrect: Expected '%s', but got '%s'", name, expected, actual)
+	}
+}
+
+// AssertInt - Check if two intagers match
+func (tu *TestUtil) AssertInt(actual int, expected int, name string) {
+	if actual != expected {
+		tu.T.Errorf("%s is incorrect: Expected '%d', but got '%d'", name, expected, actual)
+	}
+}

unitTestUtil/unitTestUtil.go

@@ -0,0 +1,10 @@
+package unittestutil
+
+import (
+	"testing"
+)
+
+// TestUtil - Utility for testing
+type TestUtil struct {
+	T *testing.T
+}

utils/fileio.go

@@ -1,6 +1,7 @@
 package utils
 
 import (
+	"io/ioutil"
 	"os"
 )
 
@@ -19,3 +20,13 @@ func InitOutputDirectory(path string) {
 		os.MkdirAll(path, os.ModePerm)
 	}
 }
+
+// ReadFileToString - Reads file and returns content
+func ReadFileToString(path string) string {
+	content, err := ioutil.ReadFile(path)
+	if err != nil {
+		panic(err)
+	}
+
+	return string(content)
+}

workflows/downloadUser.go

@@ -0,0 +1,27 @@
+package workflows
+
+import (
+	client "../client"
+	models "../models"
+	utils "../utils"
+	"fmt"
+	"strings"
+)
+
+// CanUseDownloadUser - Test's if this workflow can be used for parameter
+func CanUseDownloadUser(url string) bool {
+	match := strings.Contains(url, "/")
+	return !match
+}
+
+// DownloadUser - Download all user's videos
+func DownloadUser(username string) {
+	downloadDir := fmt.Sprintf("%s/%s", models.Config.OutputPath, username)
+	uploads := client.GetUserUploads(username)
+
+	utils.InitOutputDirectory(downloadDir)
+
+	for _, upload := range uploads {
+		downloadVideo(upload, downloadDir)
+	}
+}

workflows/downloadVideo.go

@@ -0,0 +1,44 @@
+package workflows
+
+import (
+	client "../client"
+	models "../models"
+	utils "../utils"
+	"fmt"
+	"regexp"
+)
+
+// CanUseDownloadSingleVideo - Check's if DownloadSingleVideo can be used for parameter
+func CanUseDownloadSingleVideo(url string) bool {
+	match, _ := regexp.MatchString("\\/@.+\\/video\\/[0-9]+", url)
+	return match
+}
+
+// DownloadSingleVideo - Downloads single video
+func DownloadSingleVideo(url string) {
+	username := models.GetUsername()
+	upload := client.GetVideoDetails(url)
+	downloadDir := fmt.Sprintf("%s/%s", models.Config.OutputPath, username)
+
+	utils.InitOutputDirectory(downloadDir)
+	downloadVideo(upload, downloadDir)
+}
+
+// DownloadVideo - Downloads one video
+func downloadVideo(upload models.Upload, downloadDir string) {
+	uploadID := upload.GetUploadID()
+	downloadPath := fmt.Sprintf("%s/%s.mp4", downloadDir, uploadID)
+
+	if utils.CheckIfExists(downloadPath) {
+		fmt.Println("Upload '" + uploadID + "' already downloaded, skipping")
+		return
+	}
+
+	fmt.Println("Downloading upload item '" + uploadID + "' to " + downloadPath)
+	utils.DownloadFile(downloadPath, upload.URL)
+
+	if models.Config.MetaData {
+		metadataPath := fmt.Sprintf("%s/%s.json", downloadDir, uploadID)
+		upload.WriteToFile(metadataPath)
+	}
+}