Fix tests to get script/test to pass on Windows #5526

ashmaroli · 2016-11-02T10:00:12Z

Fix TestGeneratedSite
Fix TestFilters
Fix TestSite (only partially)
Add new helper method to skip testing symlinks on Windows

--

ref: #5241
/cc @jekyll/windows

adding a pipe character ('|') preserves the formatting of 'expected_output' with a trailing newline bit, in windows.

ashmaroli · 2016-11-02T10:02:22Z

This PR is a refined version of the referenced pull.

XhmikosR · 2016-11-02T10:03:58Z

test/test_site.rb

@@ -14,14 +14,20 @@ class TestSite < JekyllUnitTest

    should "have an array for plugins if passed as a string" do
      site = Site.new(site_configuration({ "plugins_dir" => "/tmp/plugins" }))
-      assert_equal ["/tmp/plugins"], site.plugins
+      array = Utils::Platforms.really_windows? ? ["C:/tmp/plugins"] : ["/tmp/plugins"]


Why hardcode this? You should just use the environment variable.

just use the environment variable

please explain more.

C:\Users\XhmikosR\Desktop>echo %TEMP% C:\Users\XhmikosR\AppData\Local\Temp C:\Users\XhmikosR\Desktop>echo %TMP% C:\Users\XhmikosR\AppData\Local\Temp

So, just use the environment variable, any of those two.

the path is not important here actually. This step and the next is to simply test if plugins are correctly detected as specified.
e.g. if were to set plugins_dir => "/apps/bazinga", the array returned would be:

["C:/apps/bazinga"] # on Windows and AppVeyor CI ["/apps/bazinga"] # on Unixoids and Travis CI

I'm just saying, it's bad practice hardcoding paths. Especially when you can use something a lot more reliable to detect the path.

the more I think about this, I wonder if this is a bug or intended..
when I set, plugins_dir => "/apps/plugins"
I should get a relative path to plugins dir inside my site, or an absolute_path to plugins dir with my site.

update: it works as expected, if the leading / is avoided..
~~set plugins_dir => "apps/bazinga"~~
~~then I get site.plugins == [C:/~/apps/bazinga]~~

moving this segment to a dedicated issue ticket..

parkr

Cool, looking good! Thanks for this.

Out of curiosity, why are we using really_windows? instead of just windows?

parkr · 2016-11-02T16:40:48Z

test/helper.rb

+
+  def skip_if_windows(msg = nil)
+    if Utils::Platforms.really_windows?
+      msg ||= "Jekyll doesn't currently support Symlinks on Windows"


This seems like a strange default. Is this only used in symlinks-related code? If not, I'd suggest something like Jekyll does not currently support this feature on Windows.

parkr · 2016-11-02T16:41:14Z

test/test_collections.rb

@@ -186,6 +186,9 @@ class TestCollections < JekyllUnitTest
    end

    should "include the symlinked file from site.source in the list of docs" do
+      # no support for including symlinked file on Windows
+      skip_if_windows


Then here I'd be specific with my message and say skip_if_windows, "Jekyll does not currently support symlinsk on Windows.".

parkr · 2016-11-02T16:41:51Z

test/test_entry_filter.rb

@@ -82,6 +82,9 @@ class TestEntryFilter < JekyllUnitTest

    # rubocop:disable Performance/FixedSize
    should "include only safe symlinks in safe mode" do
+      # no support for symlinks on Windows
+      skip_if_windows


Same here and everywhere you use this method – make that comment the message instead of a comment so when I run the tests, this information is surfaced.

parkr · 2016-11-02T16:42:32Z

test/test_generated_site.rb

+| - /css/screen.css last edited at #{time_regexp} with extname .css
+  - /pgp.key last edited at #{time_regexp} with extname .key
+  - /products.yml last edited at #{time_regexp} with extname .yml
+  - /symlink-test/symlinked-dir/screen.css last edited at #{time_regexp} with extname .css


Why is this necessary? Can you paste the test failure in a comment below?

@parkr 👇

Failure: TestGeneratedSite#test_: generated sites should print a nice list of static files. [C:/projects/jekyll/test/test_generated_site.rb:59] Minitest::Assertion: Expected /- \/css\/screen.css last edited at \d+:\d+ with extname .css - \/pgp.key last edited at \d+:\d+ with extname .key - \/products.yml last edited at \d+:\d+ with extname .yml - \/symlink-test\/symlinked-dir\/screen.css last edited at \d+:\d+ with extname .css / to match "\n- /css/screen.css last edited at 23:11 with extname .css\n- /pgp.key last edited at 23:11 with extname .key\n- /products.yml last edited at 23:11 with extname .yml\n- /symlink-test/symlinked-dir last edited at 23:11 with extname \n- /symlink-test/symlinked-file last edited at 23:11 with extname \n".

parkr · 2016-11-02T16:43:42Z

test/test_site.rb

@@ -175,7 +175,6 @@ def generate(site)
        method.call(*args, &block).reverse
      end
      @site.process
-      # files in symlinked directories may appear twice


Maybe say here than symlinked directories are excluded from this list and added in when not Windows.

add symlinked files to "sorted_pages" array only when testing on non-windows platforms.

Adjust the size of grouped-items array as it won't include symlinked pages in Windows.

ashmaroli · 2016-11-02T17:44:41Z

Out of curiosity, why are we using really_windows? instead of just windows?

Because ::Platforms.really_windows? is more strict than ::Platforms.windows?

parkr · 2016-11-02T17:45:51Z

Because ::Platforms.really_windows? is more strict than ::Platforms.windows?

Why do we want it to be more strict?

ashmaroli · 2016-11-02T17:51:41Z

Why do we want it to be more strict?

😃 Because currently, symlinks is known to not have native support in Windows env. But then it may work in Windows subsystem on Linux

- add a new helper method to skip tests if on Windows platform - skip those tests that fail due to lack of support for symlinked files on Windows.

The array of plugins will contain current drive-letter in Windows

ashmaroli · 2016-11-05T10:46:05Z

~~TODO: Undo Gemfile changes when codeclimate-test-reporter issue is fixed on master~~

parkr · 2016-11-09T01:13:41Z

This is looking excellent!

parkr

👌

parkr · 2016-11-09T01:14:07Z

Gemfile

@@ -22,7 +22,7 @@ group :test do
  gem "cucumber", "~> 2.1"
  gem "jekyll_test_plugin"
  gem "jekyll_test_plugin_malicious"
-  gem "codeclimate-test-reporter"
+  gem "codeclimate-test-reporter", "0.6.0"


Want to submit a separate PR for this?

@parkr, if you think, going with "~> 0.6.0" is the better way for now, I shall definitely move this to a dedicated PR. Otherwise, this will remain here to have the tests run correctly..

parkr · 2016-11-10T21:02:48Z

@jekyllbot: merge +dev

TestGeneratedSite: add "|" to preserve newline

0c234c9

adding a pipe character ('|') preserves the formatting of 'expected_output' with a trailing newline bit, in windows.

jekyllbot assigned envygeeks and parkr Nov 2, 2016

XhmikosR reviewed Nov 2, 2016

View reviewed changes

ashmaroli force-pushed the fix-win-tests branch from b2bf987 to 2ef891a Compare November 2, 2016 11:23

parkr reviewed Nov 2, 2016

View reviewed changes

parkr added windows Related to the Windows platform tests labels Nov 2, 2016

ashmaroli added 2 commits November 2, 2016 22:55

TestSite: add symlinked files only if not Windows

257e60b

add symlinked files to "sorted_pages" array only when testing on non-windows platforms.

TestFilters: adjust array size to ignore symlinks

e6b9dd1

Adjust the size of grouped-items array as it won't include symlinked pages in Windows.

ashmaroli force-pushed the fix-win-tests branch from 2ef891a to 901df5b Compare November 2, 2016 17:25

ashmaroli added 2 commits November 4, 2016 09:20

add and use 'skip_if_windows' helper method

1852e54

- add a new helper method to skip tests if on Windows platform - skip those tests that fail due to lack of support for symlinked files on Windows.

TestSite: consider dive-letter in Windows

2c68069

The array of plugins will contain current drive-letter in Windows

ashmaroli force-pushed the fix-win-tests branch from 279882a to 2c68069 Compare November 4, 2016 03:54

create orphan files with touch method

1bafbd9

ashmaroli force-pushed the fix-win-tests branch from e9a7909 to e05fd81 Compare November 5, 2016 10:34

parkr approved these changes Nov 9, 2016

View reviewed changes

ashmaroli force-pushed the fix-win-tests branch from e05fd81 to 1bafbd9 Compare November 9, 2016 17:49

parkr changed the title ~~Fix tests to get them to pass on Windows~~ Fix tests to get script/test to pass on Windows Nov 10, 2016

jekyllbot merged commit 3e1fad2 into jekyll:master Nov 10, 2016

jekyllbot added fix internal labels Nov 10, 2016

jekyllbot added a commit that referenced this pull request Nov 10, 2016

Update history to reflect merge of #5526 [ci skip]

fc66991

ashmaroli deleted the fix-win-tests branch November 11, 2016 03:36

jekyll locked and limited conversation to collaborators Jul 11, 2019

jekyllbot unassigned envygeeks Jul 11, 2019

jekyllbot added the frozen-due-to-age label Jul 11, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix tests to get script/test to pass on Windows #5526

Fix tests to get script/test to pass on Windows #5526

ashmaroli commented Nov 2, 2016 •

edited

Loading

ashmaroli commented Nov 2, 2016

XhmikosR Nov 2, 2016

ashmaroli Nov 2, 2016

XhmikosR Nov 2, 2016

ashmaroli Nov 2, 2016

XhmikosR Nov 2, 2016

ashmaroli Nov 2, 2016

ashmaroli Nov 2, 2016 •

edited

Loading

ashmaroli Nov 2, 2016

parkr left a comment

parkr Nov 2, 2016

parkr Nov 2, 2016

parkr Nov 2, 2016

parkr Nov 2, 2016

ashmaroli Nov 2, 2016

parkr Nov 2, 2016

ashmaroli commented Nov 2, 2016

parkr commented Nov 2, 2016

ashmaroli commented Nov 2, 2016

ashmaroli commented Nov 5, 2016 •

edited

Loading

parkr commented Nov 9, 2016

parkr left a comment

parkr Nov 9, 2016

ashmaroli Nov 9, 2016

parkr commented Nov 10, 2016

Fix tests to get script/test to pass on Windows #5526

Fix tests to get script/test to pass on Windows #5526

Conversation

ashmaroli commented Nov 2, 2016 • edited Loading

ashmaroli commented Nov 2, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ashmaroli Nov 2, 2016 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

parkr left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ashmaroli commented Nov 2, 2016

parkr commented Nov 2, 2016

ashmaroli commented Nov 2, 2016

ashmaroli commented Nov 5, 2016 • edited Loading

parkr commented Nov 9, 2016

parkr left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

parkr commented Nov 10, 2016

ashmaroli commented Nov 2, 2016 •

edited

Loading

ashmaroli Nov 2, 2016 •

edited

Loading

ashmaroli commented Nov 5, 2016 •

edited

Loading