Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove long disabled integration test #1034

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

d-ronnqvist
Copy link
Contributor

Bug/issue #, if applicable:

Summary

This removes an integration test—and code only used by that test—that's been disabled since the initial open source release of Swift-DocC.

The original reason for disabling this test was that it makes real network requests to a local preview server. This behavior made the test unsuitable for running in a CI environment because its effect couldn't be isolated. Since the purpose of the test is to test real network request to the local preview server, there's no reasonable expectation for reenabling this test.

Dependencies

None

Testing

None.

Checklist

Make sure you check off the following items. If they cannot be completed, provide a reason.

  • Added tests
  • Ran the ./bin/test script and it succeeded
  • Updated documentation if necessary

There's no reasonable expectation for reenabling this test because the attributes that make it unsuitable for running in CI won't change
Copy link
Contributor

@mayaepps mayaepps left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can this test be rewritten without the network requests? From the comments it seems like the test was meant to ensure the preview request recovered after a failed convert attempt, which seems like behavior it would still be nice to test.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants