PHPUnit Plugin Integration Tests: Getting wordpress-tests-lib PHP into IDE (VS Code)

The best solution I’ve found is to make a symlink from the plugin directory to the actual location of the /wordpress-tests-lib/.

At least in the case of VS Code, the symlink seems to help it “find” the files and incorporate them into autocomplete etc. I’m still having bugs but this is the best I could do.

Find the temporary directory

There’s probably a smarter way, but I found my test dir by just echoing it out to the terminal when I run phpunit.

Edit the bootstrap.php file from your plugin like so:

add echo "$_tests_dir" after the variable is set up

Then run phpunit in the terminal and copy your path URL. Mine (mac) is

/var/folders/sn/y4jh01gs67xbbdh2v7zy_86w0000gn/T/wordpress-tests-lib

Add the symlink to the plugin dir

Open your plugin in the terminal and add the link with the following command:

ln -s /PATH/ _wordpress-tests-lib

You can use a different link string if you want, it shouldn’t matter.

So here’s the actual command I ran:

ln -s /var/folders/sn/y4jh01gs67xbbdh2v7zy_86w0000gn/T/wordpress-tests-lib/ _wordpress-tests-lib

After this I restarted my IDE to ensure it rescanned the directories, and the class was no longer marked as undefined.

Add the symlink to .gitignore

For bonus points, you can block the symlink from showing up in Git, which you probably want because it will be pointing to a directory that is system-specific.

Just add _wordpress-tests-lib to a new line in your .gitignore file and commit the change.

Related Posts:

  1. Where can I find documentation for the WP_UnitTestCase factory classes?
  2. How to set up a user inside unit tests
  3. WordPress test environment on windows
  4. Can I simulate a user being logged in from a WP_UnitTestCase?
  5. Writing a unit test for add_menu_page
  6. Can’t get the phpunit core test for WordPress to work [closed]
  7. struggling to set up WP tests
  8. How can I properly set up dependencies in automated testing?
  9. How do I mock get_adjacent_post for testing
  10. Using factory.php outside of trunk for unit testing
  11. unit testing admin password
  12. What is the best way to create a factory for unit test objects?
  13. Extending WP_UnitTestCase without any Tests
  14. What make possible unit test plugins?
  15. Error Testing create_empty_blog() via PHPUnit + Unit Tests
  16. Write integration test for rest_pre_serve_request
  17. How to do an unit test for the admin dashboard
  18. How can I link tests to GitHub issues?
  19. How do I unit test a plugin with forms?
  20. How can I enable IDE integration (autocomplete) for WordPress test suite
  21. C++ IDE for Macs
  22. What is an “internal error” and how do I fix it?
  23. C++ IDE with repl?
  24. Unresolved reference issue in PyCharm
  25. IDE for OCaml language
  26. Anyone know how to solve the error of “collect2.exe: error: ld returned 1 exit status” when a program in C is running?
  27. What’s a good IDE for Erlang programming?
  28. How do I autoindent in Netbeans?
  29. Re-enable “component tree” in Android Studio
  30. Testing hooks callback
  31. Unit testing in the WordPress backend (is_admin() is true)
  32. How do I mock HTTP requests for PHPUnit?
  33. Access post from post id in URL
  34. Any guides on using WP SVN with IDE clients? [closed]
  35. WordPress Themes and PHP unit
  36. Unit tests – Dealing with dependencies
  37. When unit testing a plugin, does the plugin need to be in the wp-content/plugins directory of the WordPress tests install?
  38. Writing test cases for a WordPress Plugin that has translations
  39. WordPress Unit Testing – Cannot Create Tables
  40. Plugin Unit Test for Table and Option Creation
  41. How to write testable classes in WordPress
  42. How to create a test that calls is_front_page in phpunit?
  43. Using wp_mail during an integration test
  44. How to get vim to autocomplete WordPress API functions?
  45. Why Can’t PHPUnit UnitTest My WordPress Website
  46. Unit testing to simulate the loop
  47. WP_UnitTestCase missing?
  48. What is the best way to do unit tests for your plugin in 2018 [closed]
  49. Is there any way of of making an admin-ajax request without the use of die()?
  50. Aptana: WordPress Code Hinting
  51. Using Travis CI to run unit tests and running phpunit locally [closed]
  52. Plugin development with unit tests
  53. Unit testing wordpress plugins with plugin options
  54. How to properly test a method that is called by an action hook
  55. Documentation for IDE’s
  56. Install and load additional plugins when running unit tests
  57. Unit Testing a Plugin functionality with cron
  58. PHPUnit test plugin activation
  59. Installing WordPress Theme Unit Data
  60. How to add an image for unit testing?
  61. Fatal error: Maximum execution time of 60 seconds exceeded in H:\wamp\www\custom\wp-includes\class-wp-http-curl.php
  62. DataBase connection problem with PHPUnit and WordPress
  63. how to set context in WordPress for unit testing
  64. Switching from editing on directly on remote server to PHPstorm local development?
  65. Setting Up PHPUnit tests for WP development on Windows
  66. Testing custom API endpoint with class dependency
  67. How to verify meta box is registered in Unit Testing?
  68. Theme unit test data Foreign fonts come in garbled on my machine
  69. How to initialize something in unit test before the init hook being called?
  70. How to cancel WordPress’ action/filter when using OOP with anonymous callback
  71. Error when setting up phpunit tests with wp-cli scaffold
  72. How do I phpunit test a post output process?
  73. Underscores Theme Unit Testing – Catching Untitled Posts
  74. Am I testing this right?
  75. Unit testing a plugin with a theme dependency
  76. How to retain table data in wordpress phpunit tests
  77. WordPress Automatic Testing Probelm
  78. Using My Own Classes On Wp Unit Tests
  79. Why is one phpunit test throwing an error on one class when all other classes are similar without error?
  80. How to import Theme Unit Test on localhost
  81. Unable to get a simple plugin admin page to work
  82. Integration tests test script enqueue/register fails
  83. PHPUnit via WP-CLI: Warning: Cannot modify header information … bootstrap.php:68
  84. Set up PHPUnit with WordPress: The WordPress tests are 3 – 4 years old; does it matter?
  85. no_rest_route in Unit Testing for REST endpoint for CPT registered via show_in_rest
  86. Mocking WP_CLI static methods in unit tests
  87. Can any IDE (eg PHPStorm, VS Code) correctly show functions added via require get_template_directory() string results?
  88. PHPUnit Testing and woocommerce Constant
  89. WordPress and WordPress-test-lib not getting added to tmp folder
  90. Integration test – remove the mu plugins in the test
  91. How can I Edit WordPress Page in IDE like PhpStorm or Sublime?
  92. WordPress / PhpStorm / XDebug and plugin_dir_path issues
  93. Is it a good idea to edit WordPress within Eclipse? [closed]
  94. Method ‘post_title’ not found in class.
  95. Unregister Settings Error
  96. Which IDE best for WordPress Development? [closed]
  97. PHPUnit Ajax Serialization of ‘Closure’ is not allowed
  98. PHPUnit Testing Installation Issue
  99. Testing Plugin – Install plugin dependencies in testing enviroment
  100. If you already have a copy of the code, is there any reason to create a feature branch?