Skip to content

TESTING.md

Latest commit

 

History

History
170 lines (127 loc) · 5.56 KB

TESTING.md

File metadata and controls

170 lines (127 loc) · 5.56 KB
Raw

Meta-Scraper Logo Testing Guide for Meta-Scraper

Version License

This comprehensive guide will help you effectively test the Meta-Scraper extension to ensure all features are working correctly.

📋 Table of Contents

🚀 Testing Installation Methods

Method 1: Install from VSIX package (Recommended for end-users)

  1. Open VS Code
  2. Press Ctrl+Shift+X (or Cmd+Shift+X on Mac) to open Extensions
  3. Click the "..." menu in the top-right corner
  4. Select "Install from VSIX..."
  5. Navigate to and select metascraper-0.0.1.vsix
  6. Restart VS Code after installation

Method 2: Run in Development Mode (For developers)

  1. Open the project in VS Code: 
    code --new-window .
  2. Press F5 or go to Run > Start Debugging
  3. This launches an "Extension Development Host" window
  4. Test your extension in this development window
  5. Changes to code require restarting the debugging session

🖼️ Testing with Sample Images

Option 1: Use Your Own Images

  1. Copy images into the test-image directory
  2. Right-click on an image and select "View Image Metadata"
  3. Check what metadata exists in the image
  4. Right-click again and select "Clean Image Metadata"
  5. View metadata again to verify cleaning was successful

Option 2: Create Test Images with Metadata

We've included a script that adds artificial test metadata to any image, perfect for testing the cleaning functionality:

# First install dependencies
npm install

# Then run the script on any image
node test-image/add-test-metadata.js test-image/your-image.jpg

The script adds:

  • GPS coordinates
  • Camera information
  • Creation timestamps
  • Copyright details
  • Author information

✅ Feature Testing Checklist

Use this checklist to verify all extension features are working properly:

Feature Test Steps Expected Result Status
View Metadata Right-click image → "View Image Metadata" JSON metadata displayed in new document ⬜
Clean Metadata Right-click image → "Clean Image Metadata" Progress notification → Success message ⬜
Verify Cleaning View metadata after cleaning Most/all metadata fields removed ⬜
Image Integrity Open image after cleaning Image appears identical to original ⬜
Error: Non-Image Right-click non-image file → try commands Proper error message shown ⬜
Error: Read-Only Test with read-only image Graceful error handling ⬜
Large Images Test with high-resolution image Successfully processes without timeout ⬜

🔧 Troubleshooting

If you encounter issues during testing:

  1. Command not appearing in context menu

    • Ensure the extension is properly installed
    • Verify you're right-clicking on a supported image format
    • Try reloading the VS Code window

  2. Metadata not fully removed

    • Some specialized file formats may retain certain metadata
    • Check if the file is locked by another application
    • Try saving the image to a new location first

  3. Performance issues with large files

    • Processing very large images may take longer
    • Ensure your system has sufficient resources available

🔬 Advanced Testing

For more thorough testing, try these advanced scenarios:

  • Test with multiple image formats (JPG, PNG, GIF, TIFF, WebP)
  • Test with unusually large image files (20MB+)
  • Test with images containing extensive metadata
  • Test the extension while other resource-intensive operations are running
  • Test with images in read-only locations or with restricted permissions

📝 Reporting Issues

If you encounter bugs or have feature suggestions:

  1. Check existing issues on GitHub to see if it's already reported
  2. Create a new issue with:
    • A clear descriptive title
    • Detailed steps to reproduce
    • Expected vs. actual behavior
    • VS Code version and OS information
    • Screenshots or logs if available

Thank you for helping test Meta-Scraper!

Back to Main Repository • View README • Publishing Guide