Merge pull request #377 from r-plus/ci/unit_test

run unit test in CI

.github/workflows/main.yml

@@ -9,4 +9,33 @@ jobs:
 
     steps:
     - uses: actions/checkout@v2
-    - run: make
+    - name: Build XVim with UNIT_TEST flag
+      run: make unit-test
+    - name: Remove codesign
+      run: |
+        XCODE_PATH=$(xcode-select -p)
+        codesign -dvvv ${XCODE_PATH%%/Contents*}
+        sudo codesign --remove-signature ${XCODE_PATH%%/Contents*}
+        codesign -dvvv ${XCODE_PATH%%/Contents*} || true
+    - name: Register XVim as lodable plugin
+      run: |
+        ./Tools/add_plugin_filed_to_preference.sh
+        defaults read com.apple.dt.Xcode
+    - name: Run unit test
+      timeout-minutes: 5
+      run: |
+        echo "set debug" > ~/.xvimrc
+        touch ~/.xvimlog
+        XCODE_PATH=$(xcode-select -p)
+        open -a ${XCODE_PATH%%/Contents*} XVim2.xcodeproj
+        tail -f ~/.xvimlog &
+        while :
+        do
+          result=$(grep "unit test finished" ~/.xvimlog || true)
+          if [ -n "${result}" ]; then
+            # automatically exit non-zero if grep exit code is non-zero by -e option of running shell
+            grep "^0 Failing Tests$" ~/.xvimlog > /dev/null 2>&1
+            exit 0
+          fi
+          sleep 1
+        done

Makefile

@@ -14,6 +14,8 @@ release: uuid
 debug: uuid
 	$(xcodebuild) Debug $(REDIRECT)
 
+unit-test:
+	$(xcodebuild) Release GCC_PREPROCESSOR_DEFINITIONS=UNIT_TEST=1 $(REDIRECT)
 
 clean: clean-release clean-debug
 

Tools/add_plugin_filed_to_preference.sh

@@ -0,0 +1,4 @@
+#!/bin/sh
+
+XCODE_VERSION=$(xcodebuild -version | head -1 | cut -f2 -d" ")
+defaults write com.apple.dt.Xcode DVTPlugInManagerNonApplePlugIns-Xcode-${XCODE_VERSION} '{ allowed = { "net.JugglerShu.XVim2" = { version = 1; }; }; skipped = {}; }'

Tools/cert.config

@@ -0,0 +1,27 @@
+[ ca ]
+
+default_ca = CA_default
+
+[ req ]
+
+distinguished_name = req_distinguished_name
+
+x509_extensions = v3_ca
+
+#req_extensions = v3_req
+
+[req_distinguished_name ]
+
+CN = XcodeSigner
+
+[ CA_default ]
+
+x509_extensions = usr_cert
+
+[ usr_cert ]
+
+[ v3_ca ]
+
+keyUsage = critical, digitalSignature
+
+extendedKeyUsage = critical, codeSigning

Tools/create_cert.sh

@@ -0,0 +1,5 @@
+#!/bin/sh
+
+openssl req -subj '/CN=XcodeSigner' -config ./Tools/cert.config -x509 -newkey rsa:2046 -keyout selfSignedKey.pem -out selfSigned.pem -days 365 -passout pass:"foobar"
+openssl pkcs12 -export -out XcodeSigner.p12 -inkey selfSignedKey.pem -in selfSigned.pem -passin pass:"foobar" -passout pass:"foobar"
+security import XcodeSigner.p12 -P foobar

XVim2/Helper/Logger.h

@@ -23,6 +23,13 @@
 #define ERROR_LOG(fmt, ...)
 #endif
 
+#if defined UNIT_TEST
+#define UNIT_TEST_LOG(fmt, ...)                                                                                            \
+[Logger logWithLevel:LogDebug format:@"%s:%d " fmt, __PRETTY_FUNCTION__, __LINE__, ##__VA_ARGS__]
+#else
+#define UNIT_TEST_LOG(fmt, ...)
+#endif
+
 typedef NS_ENUM(NSInteger, LogLevel) {
     LogDebug,
     LogError,

XVim2/UnitTest/XVimTestCase.m

@@ -178,6 +178,7 @@ - (void)waitForCompletionWithConinuation:(void(^)(void))continuation
 
 - (void)runInWindow:(NSWindow*)window withContinuation:(void(^)(void))continuation
 {
+    UNIT_TEST_LOG(@"testing case: %@", self.desc);
     self.window = window;
 
     [self setUp];

XVim2/UnitTest/XVimTester.m

@@ -156,6 +156,7 @@ - (void)runTest
     id lastActiveWorkspace = [(IDEWorkspaceTabController*)XVimLastActiveWorkspaceTabController() workspace];
     if (lastActiveWorkspace == nil) {
         NSBeep();
+        UNIT_TEST_LOG(@"Fail to open xvimtest.cpp");
         return;
     }
     IDEEditorOpenSpecifier* spec =
@@ -190,6 +191,21 @@ -(void)runNextTest
         [self.testWindow performClose:self];
         [self showResultsTable];
 		[self dump];				
+#if defined UNIT_TEST
+        for (XVimTestCase *tc in self.testCases) {
+            if (!tc.success) {
+                UNIT_TEST_LOG(@"[Description] %@, [Pass/Fail] %@, [Message] %@, [Expected] %@, [Actual] %@",
+                              tc.desc,
+                              tc.resultDescription,
+                              tc.message,
+                              [NSString stringWithFormat:@"'%@'", [tc.expectedText escapedString]],
+                              [NSString stringWithFormat:@"'%@'", [tc.actualText escapedString]]
+                              );
+            }
+        }
+        UNIT_TEST_LOG(@"%@", [resultsString stringValue]);
+        UNIT_TEST_LOG(@"unit test finished");
+#endif
         return;
     }
 

XVim2/XVim/XVim.m

@@ -354,6 +354,13 @@ - (NSMenuItem*)xvimMenuItem
         }
         [m addItem:subm];
         [subm setSubmenu:cat_menu];
+
+#if defined UNIT_TEST
+        NSMenuItem *testItem = [[NSMenuItem alloc] init];
+        testItem.title = @"All";
+        [XVim.instance performSelector:@selector(runTest:) withObject:testItem afterDelay:10.0];
+        UNIT_TEST_LOG(@"did performSelector.");
+#endif
     }
 
     return item;